skip to main content
Using the driver : Creating and Customizing Schemas Using the DataDirect Schema Tool : Starting the Schema Tool : Launching the Schema Tool with User/ID Password Authentication or No Authentication
  

Try DataDirect Drivers Now
Launching the Schema Tool with User/ID Password Authentication or No Authentication
Take the following steps to use the Schema Tool with user/ID password authentication or no authentication.
1. Start the Schema Tool jar file. The jar file is installed in the following default locations.
*Windows systems: Program Files\Progress\DataDirect\JDBC_60\Tools\schematool.jar
*UNIX and Linux systems: /opt/Progress/DataDirect/JDBC_60/Tools/schematool.jar
The Open Schema Map window appears.
open schema map window
Note: If you are opening an existing schema map, you can reopen it either by choosing Recent Schema Map and selecting the configuration file of the schema map you want to open, or by choosing Browse to Schema Map and navigating to the configuration file of the schema map that you want to open. When an existing schema is opened, the Schema Tool automatically compares the content of the schema configuration file to a snapshot of the data on the wire. When new native objects are discovered, the Schema Tool displays them in a specialized, hierarchical view of the data and allows you to update your schema accordingly. See Mapping Newly Detected Objects for more information.
2. Select an existing schema map or create a new one (refer to the "SchemaMap" connection property topic in your driver documentation for details):
*Selecting an existing map: Select a schema map from the Recent Schema Map field or click Browse to navigate to your schema map.
*Creating a map: Click Create. Specify the schema map path by navigating to the directory where you want to store the configuration file. Type the name for the configuration file (for example, MySchema.config) in the File Name field. Click Create New Schema Map. You are returned to the Open Schema Map window where the Schema Map Location field has been populated with the path and file name of the schema map's configuration file.
3. In the fields provided, enter values for each of the connection properties described in the following table.
Table 8. Connection Properties
Property
Characteristic
Host Name
Specifies the name or the IP address of the server to which you want to connect.
Important: In a Kerberos configuration, an IP address cannot be used, and the host name must be the same as the host name used in the Kerberos service principal name.
Port Number
Specifies the port number of the server listener. The default is 27017.
4. From the Authentication Method drop-down menu, select the form of authentication appropriate to your environment.
Note: For Kerberos authentication, see "Launching the Schema Tool with Kerberos Authentication."
*Select None if you are not using either user ID/password or Kerberos authentication. Then skip to Step 6.
*Select User Name / Password to enable user ID/password authentication. Proceed to Step 5.
5. For user ID/password authentication, enter values for the authentication connection properties in the fields provided. These properties are described in the following table.
Note: It is recommended that privileges for generating the schema map be equivalent to the access privileges for an application using the driver. Your authentication settings determine for which databases the Schema Tool retrieves metadata. If authentication is not used, the Schema Tool retrieves metadata for all databases on the server. If authentication is used, the Schema Tool returns only the metadata for the database specified in the DatabaseName property. However, if you are assigned the clusterAdmin role, the Schema Tool returns metadata for all the databases on the server for which you have read privileges.
Table 9. User ID/Password Authentication Properties
Property
Characteristic
Database Name
Specifies the name of the database to which you want to connect.
User Name
Specifies the user ID that is used to connect to your database.
Password
Specifies the password that is used to connect to your database.
Note: If the values you specify for authentication properties do not match the actual values of these properties, a pop-up window appears and allows you to enter the correct values.
6. Optionally, specify configuration options to determine how native data is mapped to the relational schema. In the Configuration Options field, enter a semicolon-separated list of configuration options and their values. For example, columnDiscoverySampleSize=1000;UppercaseIdentifiers=true;. Configuration options are described in the following table. For more detail, refer to the "ConfigOptions" topic in the driver documentation.
Table 10. Schema Tool Config Options
Option
Characteristic
ColumnDiscoverySampleSize
Specifies the number of rows the driver fetches per collection when sampling data to detect columns and gather column statistics. The information collected in these samples is used when defining a schema map with the DataDirect Schema Tool. Larger fetch sizes return samples that are more representative of your data, but at the expense of slower performance. See About Column Information and Statistics for additional information on how sampling is used for statistics.
The default is 1000.
DefaultVarcharSize
Determines the default length of fields that are mapped as VARCHAR.
The default is 1.5x.
KeywordConflictSuffix
Specifies a string of up to five alphanumeric characters that the driver appends to any object or field name that conflicts with a SQL engine keyword. For example, if you specify KeywordConflictSuffix=TAB, the driver maps the Case object to CASETAB.
LeadingUnderscoreReplacement
Specifies the string of characters that replace leading underscores used in identifiers for collections, documents, and arrays.
MaxVarcharSize
Specifies the maximum default length of fields that are mapped as VARCHAR when a multiplier is specified for the DefaultVarcharSize configuration option (DefaultVarcharSize=multiplier).
MinVarcharSize
Specifies the minimum default length, in characters, of fields that are mapped as VARCHAR when a multiplier value is specified for the DefaultVarcharSize configuration option (DefaultVarcharSize=multiplier).
SchemaFilter
Specifies a comma-separated list of database and collection pairs for which you want the driver to fetch metadata. SchemaFilter can significantly improve connection times by limiting the collections for which metadata is fetched to only those that are required by your application. This value takes the following form:
SchemaFilter=database_name:collection_name[[,database_name:collection_name]...]
See "SchemaFilter (Config Option)" for detailed list of supported values.
UppercaseIdentifiers
Specifies whether the driver maps all identifier names to uppercase. By default, the driver maps all identifier names to uppercase.
If set to true, the driver maps identifiers to uppercase.
If set to false, the driver maps identifiers to the mixed case name of the object being mapped. If mixed case identifiers are used, SQL statements must enclose those identifiers in double quotation marks, and the case of the identifier must exactly match the case of the identifier name.
See Naming Conflicts for additional information about using identifiers.
The default is true.
7. To configure SSL, specify connection property values in the Connection Options field as semicolon-separated key value pairs. For example, EncryptionMethod=SSL;ValidateServerCertificate=true;HostNameInCertificate=Server3. (Only connection properties related to Kerberos and SSL can be specified in the Connection Options field.)
Note: To fully implement SSL, you must also specify SSL connection property values in the connection string used by your JDBC application. The connection property values in the Connection Options field must match the values you specify in the connection URL used by your JDBC application.
Note: When creating or opening a schema map, the Schema Tool accesses data from the server for the purpose of object mapping and generating column statistics. This process requires data to be transferred over networks, which can make data vulnerable to interception by unauthorized parties. To provide more secure transmission of data, you should consider enabling SSL.
Table 11. Data Encryption Properties
Property
Characteristic
EncryptionMethod
Determines whether data is encrypted and decrypted when transmitted over the network between the driver and database server.
To enable SSL, set EncryptionMethod to SSL.
The default is noEncryption.
HostNameInCertificate
Specifies a host name for certificate validation when SSL encryption is enabled (EncryptionMethod=SSL) and validation is enabled (ValidateServerCertificate=true). This property is optional and provides additional security against man-in-the-middle (MITM) attacks by ensuring that the server the driver is connecting to is the server that was requested.
KeyPassword
Specifies the password that is used to access the individual keys in the keystore file when SSL is enabled (EncryptionMethod=SSL) and SSL client authentication is enabled on the database server. This property is useful when individual keys in the keystore file have a different password than the keystore file.
KeyStore
Specifies the directory of the keystore file to be used when SSL is enabled (EncryptionMethod=SSL) and SSL client authentication is enabled on the database server. The keystore file contains the certificates that the client sends to the server in response to the server’s certificate request.
KeyStorePassword
Specifies the password that is used to access the keystore file when SSL is enabled (EncryptionMethod=SSL) and SSL client authentication is enabled on the database server. The keystore file contains the certificates that the client sends to the server in response to the server’s certificate request.
TrustStore
Specifies the directory of the truststore file to be used when SSL is enabled (EncryptionMethod=SSL) and server authentication is used. The truststore file contains a list of the Certificate Authorities (CAs) that the client trusts.
TrustStorePassword
Specifies the password that is used to access the truststore file when SSL is enabled (EncryptionMethod=SSL) and server authentication is used. The truststore file contains a list of the Certificate Authorities (CAs) that the client trusts.
ValidateServerCertificate
Determines whether the driver validates the certificate that is sent by the database server when SSL encryption is enabled (EncryptionMethod=SSL). When using SSL server authentication, any certificate that is sent by the server must be issued by a trusted Certificate Authority (CA).
The default is true.
8. To create a new schema map, click Open Schema Map and proceed to Creating a Schema with the Table Wizard.
9. If you are using an existing schema map, choose one of the following sampling behaviors to execute at connection:
*All Collections: The driver samples all new and existing collections to detect changes. This provides the most accurate view of your data, but, depending on the number and size of your collections, can take a long time to process.
*Only New Collections: The driver samples only newly discovered collections. This provides the quickest processing time, allowing you to begin using the tool faster. If you only want to map new collections, or if your existing collections are unchanged, this method is recommended.