Db2 Big SQL Atlas bridge

Db2® Big SQL Atlas bridge is used for batch import of metadata.

You can invoke the Db2 Big SQL Atlas bridge in one of the following ways:

By calling the ATLAS_IMPORT stored procedure
By running (as bigsql) the metadata import script (bigsql-atlas-import.sh) in $BIGSQL_HOME/libexec

Important:

If Db2 Big SQL is configured with SSL (that is, if the DB2COMM registry variable is set to SSL), the bigsql-atlas-import.sh script is not supported, and you can call the ATLAS_IMPORT stored procedure instead.
If Auto-TLS is enabled, be sure to verify that Db2 Big SQL is enabled for Ranger SSL before running the script (see Configuring Db2 Big SQL for Ranger TLS/SSL).

Metadata import script

This script includes parameters for connecting to both the Db2 Big SQL database and the Atlas server. Script output is stored in the /var/ibm/bigsql/logs/import-bigsql-atlas.log file. The script runs by using system Java™. If you want to use another Java version, set the JAVA_HOME environment variable to specify that Java version. Parameters must be specified in the order that is shown in the following description:

-H | --host: Specifies the Big SQL host name. The default is localhost.
-u | --user: Specifies a user ID for connecting to the Big SQL database. The default is bigsql.
-p | --password: Specifies a password for the user ID.
-P | --port: Specifies the Big SQL communications port. The default is 32051.
-c | --cacert: Specifies the SSL certificate keystore to use when establishing an SSL connection to Db2.
-a | --atlasUserid: Specifies the Atlas metaserver user name. This is the administrative user who is authorized to update Atlas metadata. Although an Atlas user ID is optional if the cluster is Kerberized, the user who is running the script must have a valid cached Kerberos ticket.
-w | --atlasPassword: Specifies a password for the Atlas metaserver user name. Although an Atlas password is optional if the cluster is Kerberized, the user who is running the script must have a valid cached Kerberos ticket.
-s | --schema: Specifies a schema pattern to match during metadata import. If a value is not provided, all schemas are imported. The pattern matching allows regular expressions in the LIKE predicate.
-R | --pattern: Specifies an object matching pattern that also matches the LIKE predicate’s regular expressions.
-k | --keytab: Specifies a keytab file. If your cluster is Kerberized and client Kerberos is enabled (that is, Db2 authentication is set to KERBEROS), specify the keytab file of the user who has valid Kerberos tickets.
Important: If client Kerberos authentication is enabled, specify a keytab file by using the -k parameter instead of specifying a password by using the -p parameter.

Examples

In a non-Kerberized cluster, import the metadata for all schemas whose names contain 'SAI' and objects whose names contain 'T' into Atlas.
```
./bigsql-atlas-import.sh -H nratlas-m-3
  -u bigsql -p password -P 32051 -a admin -w temp4now
  -s 'SAI%' -R 'T%'
```
In a Kerberized cluster with client Kerberos enabled, import the metadata for all schemas and for all objects into Atlas. Use some default values.
```
./bigsql-atlas-import.sh -H nratlas-m-3 
  -s % -R % 
  -k /etc/security/keytabs/bigsql.headless.keytab
```
If the schema pattern is %, all schemas in the Big SQL database are imported, regardless of the object pattern, and only the objects that match the object pattern are imported from all schemas.

Use long parameter options:


./bigsql-atlas-import.sh --host cdp311
  --user bigsql --password bigsql
  --port 32051
  --atlasUserid admin --atlasPassword admin123
  -s %  -R %

Use default values wherever possible.


./bigsql-atlas-import.sh
  --password bigsql
  --atlasUserid admin --atlasPassword admin123