DB Interfaces Overview

What Is a Database Interface?

Database interfaces are used to define connection details to a database that has a JDBC driver like Oracle, PostgreSQL or SQL Server.

A database interface includes the following details:

  • IP address of the database server and the communication port for importing data.
  • Database type like Oracle, PostgreSQL or SQL Server. The type of database influences the structure of the queries generated by the Fabric Studio.
  • Database name.
  • Connection’s authorization credentials.
  • Post connection commands.

Click for more information about Creating DB Interfaces.

Database Connection Settings

When building a DB interface it is very important that connection settings are defined accurately. Connection setting parameters depend on whether the interface is a DB interface or a Non-DB interface. The following fields are displayed for all types of DB interfaces:

Name

Database Filename.

Active

When checked indicates whether the database connection is active during runtime. When a connection is disabled it is ignored by the server side.

Type Name

Database interface type, for example, Oracle or DB2.

Server

Hostname or IP address of the database server.

In case of Cassandra interface, it is possible to define a list of IP nodes separated by ; sign for the establishment of the initial connection to the Cassandra cluster.

Port

Connection port used to communicate with the database. A default port is entered based on the type of interface selected.

Database

Database, schema or service name.

Note that for SQLite DB Interfaces, populate the database using the full path of the SQLite file.

For example: C:\SqliteDB\crm_db.db

User

Username used for database access authentication.

Password

Password used for database access authentication.

Proactive Indicator

Default = False. Defines whether Proactive Sync should be enabled.

Custom Connection String

Default = False. When set to True, the Custom Connection string is editable.

Connection String

Connection string used by the client side. This is generated according to the database type. For example, for Oracle, the string consists of jdbc:oracle:thin:@:1521/

Min Connection Number

Minimum number of connections per interface allocated by Fabric per node that remain open throughout the entire time that the Fabric project runs.

Max Connection Number

Maximum number of connections per interface per node. Note that this parameter should not exceed the maximum number of connections allocated by the DB.

Schema Filter

Name of the Database schema to access. Required if more than one schema exists. The Schema Filter setting in the DB Interface filters the list of schemas to be used by the Query Builder and DB Queries.

Connection Properties

List of JDBC Connection Properties of the selected Interface type. This section is visible only when the selected Interface type has any JDBC Connection Properties.

Previous

DB Interfaces Overview

What Is a Database Interface?

Database interfaces are used to define connection details to a database that has a JDBC driver like Oracle, PostgreSQL or SQL Server.

A database interface includes the following details:

  • IP address of the database server and the communication port for importing data.
  • Database type like Oracle, PostgreSQL or SQL Server. The type of database influences the structure of the queries generated by the Fabric Studio.
  • Database name.
  • Connection’s authorization credentials.
  • Post connection commands.

Click for more information about Creating DB Interfaces.

Database Connection Settings

When building a DB interface it is very important that connection settings are defined accurately. Connection setting parameters depend on whether the interface is a DB interface or a Non-DB interface. The following fields are displayed for all types of DB interfaces:

Name

Database Filename.

Active

When checked indicates whether the database connection is active during runtime. When a connection is disabled it is ignored by the server side.

Type Name

Database interface type, for example, Oracle or DB2.

Server

Hostname or IP address of the database server.

In case of Cassandra interface, it is possible to define a list of IP nodes separated by ; sign for the establishment of the initial connection to the Cassandra cluster.

Port

Connection port used to communicate with the database. A default port is entered based on the type of interface selected.

Database

Database, schema or service name.

Note that for SQLite DB Interfaces, populate the database using the full path of the SQLite file.

For example: C:\SqliteDB\crm_db.db

User

Username used for database access authentication.

Password

Password used for database access authentication.

Proactive Indicator

Default = False. Defines whether Proactive Sync should be enabled.

Custom Connection String

Default = False. When set to True, the Custom Connection string is editable.

Connection String

Connection string used by the client side. This is generated according to the database type. For example, for Oracle, the string consists of jdbc:oracle:thin:@:1521/

Min Connection Number

Minimum number of connections per interface allocated by Fabric per node that remain open throughout the entire time that the Fabric project runs.

Max Connection Number

Maximum number of connections per interface per node. Note that this parameter should not exceed the maximum number of connections allocated by the DB.

Schema Filter

Name of the Database schema to access. Required if more than one schema exists. The Schema Filter setting in the DB Interface filters the list of schemas to be used by the Query Builder and DB Queries.

Connection Properties

List of JDBC Connection Properties of the selected Interface type. This section is visible only when the selected Interface type has any JDBC Connection Properties.

Previous