SQL Database Resource
The DataShyft SQL Components need to know which database to connect to and how to communicate with it. This is accomplished using SQL Database Connection Resources. These resources are configured with the information required to communicate with the database servers.
When a SQL Database Connection Resource is created, it is given a specific subtype. DataShyft has built-in support for several popular databases. Once the DB type is selected, the Resource can be configured with the information required for that specific database type. For databases not explicitly supported, the SQL Database Connection resource subtype can be set to Generic JDBC Connection. This allows DataShyft to access any database that provides a JDBC library.
Note: For performance and licensing reasons, the DataShyft Runtime does not include JDBC Driver libraries. Required drivers will need to be installed on the runtime to successfully communicate with the database.
MySQL Connection Resource Configuration
A SQL Database Connection Resource with a subtype of MySQL Database allows for connection to a MySQL Database server. It requires the hostname, port, and database name to which the connection should be made.
Parameters
displayName — (String) the name to use for this resource in the Blueprint Editor.
hostname — (String) the hostname of the MySQL Server.
port — (int, default: 3306) the port on which to connect to the MySQL Server.
database — (String) name of the database to connect to when accessing the server.
credential — (Username/Password Credential) the credentials to be used to access the database.
additionalParameters — (String) additional configuration options that should be attached to the connection string. The string should be formatted as key1=value1&key2=value2&…
PostgreSQL Connection Resource Configuration
A SQL Database Connection Resource with a subtype of PostgreSQL Database allows for connection to a PostgreSQL Database server. It requires the hostname, port, database name, and schema name to which the connection should be made.
Parameters
displayName — (String) the name to use for this resource in the Blueprint Editor.
hostname — (String) the hostname of the PostgreSQL Server.
port — (int, default: 5432) the port on which to connect to the PostgreSQL Server.
database — (String) the PSQL Database to use once connected to the PostgreSQL server.
schema — (String) the specific schema to use once connected to the PostgreSQL server.
credential — (Username/Password Credential) the credentials to be used to access the database.
Oracle RDBMS Connection Resource Configuration
A SQL Database Connection Resource with a subtype of Oracle RDBMS Database allows for connection to an Oracle Database cluster. It requires the Oracle connection string to which the connection should be made.
Parameters
displayName — (String) the name to use for this resource in the Blueprint Editor.
connectionString — (String) the connection string for connecting to the Oracle server.
credential — (Username/Password Credential) the credentials to be used to access the database.
Microsoft SQL Server Connection Resource Configuration
A SQL Database Connection Resource with a subtype of MS SQL Database allows for connection to a Microsoft SQL database server. It requires the hostname, port, and database name to which the connection should be made.
Parameters
displayName — (String) the name to use for this resource in the Blueprint Editor.
hostname — (String) the hostname of the Microsoft SQL Server.
port — (int, default: 1433) the port on which to connect to the Microsoft SQL Server.
database — (String) the Database to use once connected to the Microsoft SQL Server.
credential — (Username/Password Credential) the credentials to be used to access the database.
additionalParameters — (String) additional configuration options that should be attached to the connection string. The string should be formatted as key1=value1&key2=value2&…
IBM DB2 Connection Resource Configuration
A SQL Database Connection Resource with a subtype of IBM DB2 Database allows for connection to an IBM DB2 database server. It requires the hostname, port, and database name to which the connection should be made.
Parameters
displayName — (String) the name to use for this resource in the Blueprint Editor.
hostname — (String) the hostname of the IBM DB2 Server.
port — (int, default: 25000) the port on which to connect to the IBM DB2 Server.
database — (String) the PSQL Database to use once connected to the IBM DB2 server.
credential — (Username/Password Credential) the credentials to be used to access the database.
useSSLConnection — (boolean, default: false) Specifies whether the connection should use SSL or not.
additionalParameters — (String) additional parameters to use when connecting to the database. They are specified in the following form: key1=value1&key2=value2&…
Generic JDBC Connection
A SQL Database Connection Resource with a subtype of Generic JDBC Databsae allows for connection to any JDBC-compatible Database. It requires only the JDBC URL and the class name of the Driver to use when connecting. The library containing the driver must be installed on any DataShyft Runtime where access to the database will be required.
Note: When using the Generic JDBC Resource configuration object, the URL should include any required parameters to ensure the database returns results in streaming mode. Without these parameters, the deployed blueprint may encounter out of memory errors on large queries.
Parameters
displayName — (String) the name of this resource.
url — (String) the JDBC URL to use to connect to the database.
credential — (Username/Password Credential) the credentials to be used to access the database.
driverName — (String) the class name of the JDBC driver to use when connecting to this database.