]> git.sur5r.net Git - openldap/blobdiff - doc/guide/admin/dbtools.sdf
constraint overlay section complete.
[openldap] / doc / guide / admin / dbtools.sdf
index 5e30e75ac2f2dc1f01be1209775e41eeecab7b2e..d90f10060c6a87faacd23db822b2674c53fa116d 100644 (file)
@@ -1,5 +1,5 @@
 # $OpenLDAP$
-# Copyright 1999-2000, The OpenLDAP Foundation, All Rights Reserved.
+# Copyright 1999-2007 The OpenLDAP Foundation, All Rights Reserved.
 # COPYING RESTRICTIONS APPLY, see COPYRIGHT.
 
 H1: Database Creation and Maintenance Tools
@@ -7,18 +7,18 @@ H1: Database Creation and Maintenance Tools
 This section tells you how to create a slapd database from scratch,
 and how to do trouble shooting if you run into problems. There are
 two ways to create a database. First, you can create the database
-on-line using LDAP. With this method, you simply start up slapd
+on-line using {{TERM:LDAP}}. With this method, you simply start up slapd
 and add entries using the LDAP client of your choice. This method
 is fine for relatively small databases (a few hundred or thousand
 entries, depending on your requirements). This method works for
 database types which support updates.
 
 The second method of database creation is to do it off-line using
-special utilities provided with slapd. This method is best if you
+special utilities provided with {{slapd}}(8). This method is best if you
 have many thousands of entries to create, which would take an
 unacceptably long time using the LDAP method, or if you want to
 ensure the database is not accessed while it is being created. Note
-that not all database types support these utilitites.
+that not all database types support these utilities.
 
 
 H2: Creating a database over LDAP
@@ -80,16 +80,21 @@ For example, to index the {{EX:cn}}, {{EX:sn}}, {{EX:uid}} and
 {{EX:objectclass}} attributes, the following {{EX:index}} directives
 could be used:
 
->      index cn,sn,uid
->      index objectClass pres,eq
+>      index cn,sn,uid pres,eq,approx,sub
+>      index objectClass eq
+
+This would create presence, equality, approximate, and substring
+indices for the {{EX:cn}}, {{EX:sn}}, and {{EX:uid}} attributes and
+an equality index for the {{EX:objectClass}} attribute.  Note that
+not all index types are available with all attribute types.  See
+{{SECT:The slapd Configuration File}} section for more information
+on this option.
 
-Note that not all index types are available with all attribute types.
-See {{SECT:The slapd Configuration File}} section for more details on
-this option. Once you have configured things to your liking, start up
-slapd, connect with your LDAP client, and start adding entries.  For
-example, to add an organization entry and an organizational role entry
-using the {{I:ldapadd}} tool, you could create an {{TERM:LDIF}} file
-called {{EX:entries.ldif}} with the contents:
+Once you have configured things to your liking, start up slapd,
+connect with your LDAP client, and start adding entries.  For
+example, to add an organization entry and an organizational role
+entry using the {{I:ldapadd}} tool, you could create an {{TERM:LDIF}}
+file called {{EX:entries.ldif}} with the contents:
 
 >      # Organization for Example Corporation
 >      dn: dc=example,dc=com
@@ -143,25 +148,27 @@ For example:
 
 >      directory /usr/local/var/openldap-data
 
-Finally, you need to specify which indexes you want to build.  This
+Finally, you need to specify which indices you want to build.  This
 is done by one or more index options.
 
 >      index {<attrlist> | default} [pres,eq,approx,sub,none]
 
 For example:
 
->      index cn,sn,uid pres,eq,sub
+>      index cn,sn,uid pres,eq,approx,sub
 >      index objectClass eq
 
-This would create presence, equality and substring indexes for
-the {{EX:cn}}, {{EX:sn}}, and {{EX:uid}} attributes and an equality
-index for the {{EX:objectClass}} attribute. See the configuration
-file section for more information on this option.
+This would create presence, equality, approximate, and substring
+indices for the {{EX:cn}}, {{EX:sn}}, and {{EX:uid}} attributes and
+an equality index for the {{EX:objectClass}} attribute.  Note that
+not all index types are available with all attribute types.  See
+{{SECT:The slapd Configuration File}} section for more information
+on this option.
 
 H3: The {{EX:slapadd}} program
 
 Once you've configured things to your liking, you create the primary
-database and associated indexes by running the {{slapadd}}(8)
+database and associated indices by running the {{slapadd}}(8)
 program:
 
 >      slapadd -l <inputfile> -f <slapdconfigfile>
@@ -171,14 +178,23 @@ The arguments have the following meanings:
 
 >      -l <inputfile>
 
-Specifies the LDIF input file containing the entries to add in text
-form (described below in the {{SECT:The LDIF text entry format}}
-section).
+Specifies the {{TERM:LDIF}} input file containing the entries to
+add in text form (described below in the {{SECT:The LDIF text entry
+format}} section).
 
 >      -f <slapdconfigfile>
 
 Specifies the slapd configuration file that tells where to create
-the indexes, what indexes to create, etc.
+the indices, what indices to create, etc.
+
+>      -F <slapdconfdirectory>
+
+Specifies a config directory.  If both {{EX:-f}} and {{EX:-F}} are specified, 
+the config file will be read and converted to config  directory format and 
+written to the specified directory.  If neither option is specified, an attempt 
+to read the default config directory will be made before trying to use the 
+default config file. If a valid config directory exists then the default 
+config file is ignored. If dryrun mode is also specified, no conversion will occur.
 
 >      -d <debuglevel>
 
@@ -228,8 +244,8 @@ your database off-line.  The program is invoked like this:
 
 where {{EX:-n}} or {{EX:-b}} is used to select the database in the
 {{slapd.conf}}(5) specified using {{EX:-f}}.  The corresponding
-LDIF output is written to standard output or to the file specified
-using the {{EX:-l}} option.
+{{TERM:LDIF}} output is written to standard output or to the file
+specified using the {{EX:-l}} option.
 
 
 !if 0