Administrator Guide : Using solidDB® data management tools : solidDB® Data Dictionary (soldd) : Starting solidDB® Data Dictionary (soldd)
  
Starting solidDB® Data Dictionary (soldd)
Start solidDB® Data Dictionary (soldd) with the command soldd.
If you start solidDB® Data Dictionary with no arguments, you will see a summary of the arguments with a brief description of their usage.
The syntax for starting soldd is:
soldd [options] [network_name] username [password] {tablename
where
▪options can be:
Option
Description
-c dir
Change working directory
-C catalog_name
Set the default catalog from where data definitions are read from or written to
-h, -?
Help = Usage
-m
In Unicode databases (General.InternalCharEncoding=UTF8), expect the data in character and wide character data type columns to be encoded in the console’s locale/codepage, despite the settings in the server-side and client-side character data binding parameters.
In partial Unicode databases (General.InternalCharEncoding=Raw), expect the data in wide character data type columns to be encoded in the console’s locale/codepage, despite the settings in the server-side and client-side character data binding parameters. Data in character data type columns is not converted.
See Using solidDB® tools with Unicode for more information.
-M locale_name
In Unicode databases (General.InternalCharEncoding=UTF8), expect the data in character and wide character data type columns to be encoded in the specified locale/codepage.
In partial Unicode databases (General.InternalCharEncoding=Raw), expect the data in wide character data type columns to be encoded in the specified locale/codepage. Data in character data type columns is not converted.
The format of locale_name depends on the operating system.
For example, in Linux environments, the locale name for the code page GB18030 in Chinese/China is zh_CN.gb18030.
In Windows environments, the locale name for Latin1 code page in Finnish/Finland is fin_fin.1252.
See Using solidDB® tools with Unicode for more information.
-o filename
Write data definitions to this file
-O filename
Append data definitions to this file
-p
Preserve case of schema and table names
-s schema_name
List definitions from this schema only
-u
▪In Unicode databases (General.InternalCharEncoding=UTF8), expect the data in character and wide character data type columns to be encoded in UTF-8.
▪In partial Unicode databases (General.InternalCharEncoding=Raw), expect the data in wide character data type columns to be encoded in UTF-8. Data in character data type columns is not converted.
See Using solidDB® tools with Unicode for more information.
-x tableonly
List table definitions only
-x indexonly
List index definitions only
-x viewonly
List view definitions only
-x sequenceonly
List sequence definitions only
-x procedureonly
List procedure definitions only
-x publicationonly
List publication definitions only
-x eventonly
List event definitions only
-x triggeronly
List trigger definitions only
-x schemaonly
List schema definitions only
-x hiddennames
List internal constraint names only
-x pwdfile: filename
Read password from the file
▪network_name is the network name of a solidDB® server that you are connected to. The given network name must be enclosed in quotation marks. Refer to Managing network connections for further information. Logical data source names can also be used with the solidDB® tools.
▪username is required to identify the user and to determine the authorization level of the user authorization. Without appropriate rights, command execution is denied.
▪password is the password of the user for accessing the database. The password is mandatory, if the password is not read from a file (defined with option -x pwdfile: filename), or optional, if the password is read from a file
If no table name is given, all definitions to which the user has rights are listed.
If the objectname parameter is provided with one of the -x options, the name is used to print only the definition of the named object.
The -t tablename option is still supported in order to keep old scripts valid.
Error messages
When there is an error in the soldd startup command line, soldd gives you a list of the possible syntax options as a result. Check the command line you entered.
solidDB® Data Dictionary examples
soldd -odatabase.sql "tcp database_server 1313" dbadmin f1q32j4
Print the definition of procedure TEST_PROC:
soldd -x procedureonly " " dba dba TEST_PROC
Related concepts
Troubleshooting a problem
See also
solidDB® Data Dictionary (soldd)