dbscan(1)

dbscan1

Scans a directory server database index file and dumps the contents

Usage

dbscan -f <filename> [-R] [-t <size>] [-K <entry_id>] [-k <key>] [-l <size>] [-G <n>] [-n] [-r] [-s]

Overview

Scans a Directory Server database index file and dumps the contents.

Options

A summary of options is included below:

common options:

-A, --ascii

dump as ascii data

-D, --db-type <filename>

specify db type: bdb or mdb

-f, --dbi <filename>

specify db instance

-R, --raw

dump as raw data

-t, --truncate-entry <size>

entry truncate size (bytes)

entry file options:

-K, --entry-id <entry_id>

lookup only a specific entry id

index file options:

-G, --id-list-min-size <n>

only display index entries with more than <n> ids

-I, --import <file>

Import database instance from file. Requires --do-it parameter WARNING! Only the id2entry and replication_changelog database instances may be imported by dbscan.

-k, --key <key>

lookup only a specific key

-l, --id-list-max-size <size>

max length of dumped id list (default 4096; 40 bytes <= size <= 1048576 bytes)

-n, --show-id-list-lenghts

display ID list lengths

--remove

remove a db instance. Requires --do-it parameter

-r, --show-id-list

display the contents of ID list

-S, --stats

display statistics

-X, --export <file>

Export database instance to file

other options:

-s, --summary

Summary of index counts

-L, --list

List od database instances

--do-it

confirmation required for actions that change the database contents

-h, --help-it

display the usage

Usage

Sample usages:

List the database instances

dbscan -L /var/lib/dirsrv/slapd-supplier1/db

Dump the entry file:

dbscan -f id2entry.db4

Display index keys in cn.db4:

dbscan -f cn.db4

Display index keys in cn on lmdb:

dbscan -f /var/lib/dirsrv/slapd-supplier1/db/userroot/cn.db
(Note: Use dbscan -L db_home_dirget the db instance path)

Display index keys and the count of entries having the key in mail.db4:

dbscan -r -f mail.db4

Display index keys and the IDs having more than 20 IDs in sn.db4:

dbscan -r -G 20 -f sn.db4

Display summary of objectclass.db4:

dbscan -s -f objectclass.db4

Releases

7 releases since Debian 8 (Jessie); the text changed 4 times.

  1. 8
  2. 9–10
  3. 11
  4. 12
  5. 13–Arch

--ascii since Debian 13 (Trixie); --db-type since Debian 13 (Trixie); --dbi since Debian 13 (Trixie); --do-it since Debian 13 (Trixie); --entry-id since Debian 13 (Trixie); --export since Debian 13 (Trixie); --help-it since Debian 13 (Trixie); --id-list-max-size since Debian 13 (Trixie); --id-list-min-size since Debian 13 (Trixie); --import since Debian 13 (Trixie); --key since Debian 13 (Trixie); --list since Debian 13 (Trixie); --raw since Debian 13 (Trixie); --remove since Debian 13 (Trixie); --show-id-list since Debian 13 (Trixie); --show-id-list-lenghts since Debian 13 (Trixie); --stats since Debian 13 (Trixie); --summary since Debian 13 (Trixie); --truncate-entry since Debian 13 (Trixie); -A since Debian 13 (Trixie); -D since Debian 13 (Trixie); -I since Debian 13 (Trixie); -L since Debian 13 (Trixie); -S since Debian 13 (Trixie); -X since Debian 13 (Trixie); -h since Debian 13 (Trixie).

Author

dbscan was written by the 389 Project.

Reporting bugs

Report bugs to https://github.com/389ds/389-ds-base/issues/new

From 389-ds-base 3.3.1-1 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.