Database & different database types

Database

After choosing 'Database' as the Connection type, the subsequent fields will auto-populate as follows:

  • Database Type: This includes a list of supported database types: Athena, DocumentDB, ElasticSearch, MongoDB, MySQL, Oracle, Postgres, Redshift, Snowflake, SQL Server, Teradata, Other, etc

Depending on what database type you select, additional fields will be populated. Let's go through each connection type:

Athena

After selecting 'Athena' as the database type, you will be presented with a set of fields:

  • Max Connections: This field allows you to specify the maximum number of connections that can be made to the Athena database simultaneously. You can enter a value between 1 and 100, depending on your requirements.
  • Driver Class Name: This is the class name of the JDBC driver used to connect to the Athena database. It is a technical detail necessary for establishing the connection and is typically predefined based on the JDBC driver being used.
  • JDBC URL: The JDBC URL is the connection string used to connect to the Athena database. It contains information such as the AWS region, the endpoint for Athena, and any additional parameters required for authentication and configuration.
  • Database: This field displays the name of the Athena database you are connecting to. 
  • Username: Enter the username associated with your Athena database. This is typically required for authentication purposes.
  • Password & Confirm Password: These fields allow you to securely input the password associated with the provided username for accessing the Athena database. Confirming the password ensures accuracy and prevents input errors.
  • Quote Character: By default, the quote character is set to the double quote ("). This character is used for enclosing identifiers in SQL queries, such as table or column names. You can adjust this setting based on your specific requirements or database conventions.

DocumentDB

After selecting 'DocumentDb' as the database type, you will be presented with a set of fields:

  • Host: This field expects the hostname or IP address of your DocumentDB cluster. It identifies the location of the DocumentDB instance you want to connect to.
  • Port: Here, you provide the port number through which your DocumentDB instance can be accessed. DocumentDB typically uses port 27017 for standard connections.
  • Database: Enter the name of the database within your DocumentDB cluster that you intend to work with. This could be an existing database or the name of a new one you plan to create.
  • Username: Specify the username associated with your DocumentDB database. This is often required for authentication purposes to ensure secure access.
  • Password & Confirm Password: Input the password corresponding to the provided username for accessing your DocumentDB database. Confirming the password ensures accuracy and helps prevent input errors.
  • Collection Name: If you are working with a DocumentDB collection specifically, provide the name of the collection you want to interact with. Collections are containers for JSON documents within DocumentDB.
  • Mode: This field determines the read preference mode for your DocumentDB connection. Common options include "Primary," "PrimaryPreferred," "Secondary," and "SecondaryPreferred," allowing you to specify where reads should be directed in a multi-node setup.
  • Quote Character: By default, the quote character is often set to the double quote ("). This character is used for enclosing identifiers in SQL queries, such as table or column names. You can adjust this setting based on your specific requirements or database conventions.

ElasticSearch

After selecting 'ElasticSearch' as the database type, you will be presented with a set of fields:

  • Max Connection: This field allows you to specify the maximum number of connections that can be made to the Elasticsearch database simultaneously. It's important for managing resource usage and preventing overload.
  • Driver Class Name: The driver class name is a technical detail representing the JDBC driver used to connect to Elasticsearch. It's predefined based on the JDBC driver being used and is essential for establishing the connection.
  • JDBC URL: The JDBC URL serves as the connection string used to establish a connection to the Elasticsearch database. It typically includes information such as the host, port, and any additional parameters required for authentication and configuration.
  • Index Name: Enter the name of the Elasticsearch index you want to interact with. An index is similar to a database in relational databases and is used to organize and store documents.
  • ES Type: This field specifies the Elasticsearch document type you are working with. Document types allow you to organize similar documents within an index.
  • Database: Although Elasticsearch is not a traditional database, this field may refer to the concept of an index or a specific data repository within your Elasticsearch instance.
  • Username: Provide the username required for authentication when accessing your Elasticsearch database. This is typically used for securing access to sensitive data and operations.
  • Password & Confirm Password: These fields allow you to securely input the password associated with the provided username for accessing the Elasticsearch database. Confirming the password ensures accuracy and helps prevent input errors.
  • Quote Character: By default, the quote character is often set to the double quote ("). This character is used for enclosing identifiers in SQL queries, such as table or column names. You can adjust this setting based on your specific requirements or database conventions.

MongoDB

After selecting 'ElasticSearch' as the database type, you will be presented with a set of fields:

  • Host: The host field specifies the hostname or IP address of the MongoDB server you want to connect to. It identifies the location of the MongoDB instance where your database is hosted.
  • Port: The port field specifies the port number through which your MongoDB instance can be accessed. By default, MongoDB uses port 27017 for standard connections.
  • Database: This field refers to the name of the MongoDB database you intend to work with. It could be an existing database or the name of a new one you plan to create.
  • Username: The username field requires the username associated with your MongoDB database. This username is typically used for authentication purposes to ensure secure access to the database.
  • Password & Confirm Password: These fields allow you to input the password associated with the provided username for accessing your MongoDB database. Confirming the password ensures accuracy and helps prevent input errors.
  • Collection Name: The collection name field specifies the name of the MongoDB collection you want to interact with. A collection is a group of MongoDB documents and is equivalent to a table in relational databases.
  • Mode: The mode field determines the read preference mode for your MongoDB connection. Common options include "Primary," "PrimaryPreferred," "Secondary," and "SecondaryPreferred," allowing you to specify where reads should be directed in a multi-node setup.
  • Quote Character: By default, the quote character field may be set to a specific character such as a double quote ("). This character is used for enclosing identifiers in queries, such as collection or field names. You can adjust this setting based on your specific requirements or database conventions.

MYSQL

After selecting 'MYSQL' as the database type, you will be presented with a set of fields:

  • Max Connections: This field defines the maximum number of simultaneous connections allowed to the MySQL database. It's essential for controlling resource usage and preventing overload on the database server. You can enter a value between 1 and 100, depending on your requirements.
  • Host: The host field specifies the hostname or IP address of the server where the MySQL database is hosted. It's the location where your database server resides.
  • Port: The port field indicates the port number through which the MySQL database server communicates. The default port for MySQL is 3306, but it can be customized based on your server configuration.
  • Database: The database field refers to the name of the MySQL database you want to connect to. It represents the specific data repository within the MySQL server where your data is stored.
  • Username: This field requires the username associated with your MySQL database. It's used for authentication purposes and determines the level of access the user has to the database.
  • Password & Confirm Password: These fields are for inputting the password required for authenticating the provided username when accessing the MySQL database. Confirming the password ensures accuracy and helps prevent input errors.
  • Quote Character: The quote character field specifies the character used for enclosing identifiers in SQL queries, such as table or column names. The default quote character is often set to the backtick (`), but it can be adjusted based on your specific requirements or database conventions.

Oracle

After selecting 'Oracle' as the database type, you will be presented with a set of fields:

  • Max Connections: This field specifies the maximum number of simultaneous connections allowed to the Oracle database. It helps manage resource allocation and prevents overload on the database server.
  • Host: The host refers to the network address or hostname of the server where the Oracle database is running. It identifies the location of the database server on the network.
  • Port: The port number is the communication endpoint used to access the Oracle database on the server. It is a numerical value that allows applications to establish connections to the database server through the network.
  • Database: The database name refers to the specific Oracle database instance that you want to connect to. It identifies the logical container for storing and managing data within the Oracle database server.
  • Username: The username is the unique identifier used to authenticate and authorize access to the Oracle database. It represents a specific user account with privileges and permissions to perform operations on the database.
  • Password & Confirm Password: These fields allow you to input and confirm the password associated with the provided username for accessing the Oracle database. Confirming the password helps ensure accuracy and prevent input errors during the login process.
  • Quote Character: The quote character refers to the symbol used to enclose identifiers, such as table or column names, in SQL queries. By default, it is often set to the double quote ("). This setting can be adjusted based on your specific requirements or database conventions.

Postgres

After selecting 'Postgres' as the database type, you will be presented with a set of fields:

  • Max Connections: This field allows you to specify the maximum number of simultaneous connections that can be made to the Postgres database. It helps manage the resources of the database server and prevent overload.
  • Host: The Host field refers to the hostname or IP address of the server where your Postgres database is hosted. This is the address that your application will use to connect to the database server.
  • Port: Port specifies the network port number on which the Postgres database server is listening for connections. The default port for Postgres is 5432, but it may be configured differently based on your setup.
  • Database: The Database field specifies the name of the Postgres database that you want to connect to. This is the specific database within the Postgres server where your data is stored.
  • Username: Username is the username used for authenticating access to the Postgres database. It represents the user identity that your application will use to interact with the database.
  • Password & Confirm Password: These fields allow you to securely input the password associated with the provided username for accessing the Postgres database. Confirming the password ensures accuracy and helps prevent input errors.
  • Quote Character: The Quote Character field determines the character used for enclosing identifiers in SQL queries, such as table or column names. In Postgres, double quotes (") are commonly used as the quote character, but you can configure it based on your specific requirements or database conventions.

RedShift

After selecting 'RedShift' as the database type, you will be presented with a set of fields:

  • Max Connections: This field allows you to specify the maximum number of concurrent connections that can be established with your Amazon Redshift cluster. It helps in managing resource utilization and preventing overload on the cluster.
  • Host: The host field refers to the endpoint or domain name of your Amazon Redshift cluster. It specifies the location of the cluster where your database resides and enables the connection to be established.
  • Port: Port is the network port number through which your Amazon Redshift cluster can be accessed. The default port for Amazon Redshift is 5439, but you may need to specify a different port if your cluster is configured differently.
  • Database: The database field requires the name of the specific database within your Amazon Redshift cluster that you want to connect to. Redshift allows you to create multiple databases within a cluster to organize and segregate your data.
  • Username: The username field expects the username associated with your Amazon Redshift database. This username is used for authentication purposes when connecting to the database and is typically created during the setup of your Redshift cluster.
  • Password & Confirm Password: These fields are for inputting the password corresponding to the provided username for accessing your Amazon Redshift database. Confirming the password ensures accuracy and helps prevent input errors. It's crucial to keep your password secure to maintain the integrity of your database.
  • Quote Character: By default, the quote character is often set to the double quote ("). This character is used for enclosing identifiers in SQL queries, such as table or column names. You can adjust this setting based on your specific requirements or database conventions.

Snowflake

After selecting 'Snowflake' as the database type, you will be presented with a set of fields:

  • Max Connections: This field allows you to specify the maximum number of concurrent connections allowed to the Snowflake database from your application. It helps manage resource utilization and prevent overload on the database.
  • Account: The Account field requires you to enter the unique identifier or URL of your Snowflake account. It typically follows the format <account_name>.snowflakecomputing.com and is provided by your Snowflake administrator.
  • Virtual Warehouse: Virtual Warehouse, also known as a compute cluster, is an essential component of Snowflake architecture. It represents the computing resources allocated for running queries and processing data within Snowflake. You can specify the virtual warehouse you want to use for your database operations.
  • Database: In the Database field, you need to enter the name of the Snowflake database you want to connect to. Snowflake databases are logical containers that hold schemas, tables, and other database objects.
  • Username: This field requires you to input the username associated with your Snowflake account. The username is used for authentication purposes when accessing the Snowflake database.
  • Password & Confirm Password: These fields allow you to securely input the password associated with the provided username for accessing the Snowflake database. Confirming the password ensures accuracy and helps prevent input errors.
  • Quote Character: By default, the quote character is often set to the double quote ("). This character is used for enclosing identifiers in SQL queries, such as table or column names. You can adjust this setting based on your specific requirements or database conventions.

SQL Server

After selecting 'SQL Server' as the database type, you will be presented with a set of fields:

  • Max Connections: This field allows you to specify the maximum number of simultaneous connections that can be made to the SQL Server database. It helps manage resource usage and ensures that the database does not become overloaded with connection requests.
  • Host: The host refers to the hostname or IP address of the server where the SQL Server database is located. It identifies the location of the database server on the network.
  • Port: The port number is the communication endpoint through which your application connects to the SQL Server database. It is part of the connection information and helps direct network traffic to the appropriate service on the server.
  • Database: This field specifies the name of the SQL Server database you want to connect to. It identifies the specific database within the SQL Server instance that your application will interact with.
  • Username: The username is the login credential used to authenticate access to the SQL Server database. It is typically associated with a corresponding password and determines the level of access privileges granted to the user.
  • Password & Confirm Password: These fields allow you to securely input the password associated with the provided username for accessing the SQL Server database. Confirming the password ensures accuracy and helps prevent input errors.
  • Quote Character: By default, the quote character is often set to the double quote ("). This character is used for enclosing identifiers in SQL queries, such as table or column names. You can adjust this setting based on your specific requirements or database conventions.

Teradata

After selecting 'Teradata' as the database type, you will be presented with a set of fields:

  • Max Connections: This field allows you to specify the maximum number of concurrent connections allowed to the Teradata database. It helps manage the resource allocation and prevents overloading the database system.
  • Host: The host field refers to the hostname or IP address of the server where the Teradata database is hosted. It specifies the location of the database server that your application will connect to.
  • Port: The port field specifies the port number through which your application will communicate with the Teradata database server. Teradata databases typically use port 1025 or a custom port configured by the database administrator.
  • Database: The database field indicates the name of the Teradata database that your application will interact with. It represents the specific data repository or schema within the Teradata database system.
  • Username: Enter the username associated with your Teradata database account. This username is used for authentication purposes when connecting to the database server. It identifies your user account and determines the access privileges granted to you.
  • Password & Confirm Password: These fields allow you to securely input the password associated with the provided username for accessing the Teradata database. Confirming the password helps prevent input errors and ensures accuracy during the authentication process.
  • Quote Character: By default, the quote character is often set to the double quote ("). This character is used for enclosing identifiers in SQL queries, such as table or column names. You can adjust this setting based on your specific requirements or database conventions.

Other

After selecting 'Other' as the database type, you will be presented with a set of fields:

  • Max Connections: This field determines the maximum number of simultaneous connections allowed to the database. It helps manage resource usage and prevents overloading the database server. Users should specify a value within the supported range provided by their database system, typically based on available resources and performance considerations.
  • Driver Class Name: The Driver Class Name refers to the Java class name of the JDBC driver used to connect to the database. This driver facilitates communication between the Java application and the database server. Users need to ensure they provide the correct driver class name corresponding to the JDBC driver they are using for their specific database system.
  • JDBC URL: The JDBC URL is a connection string used to establish a connection to the database. It contains information such as the database server's hostname or IP address, port number, and any additional parameters required for authentication and configuration. Users should refer to their database documentation to construct the JDBC URL correctly for their database system.
  • Database: This field refers to the name of the database within the database management system (DBMS) that users want to connect to. It identifies the specific database where data is stored and managed. Users need to provide the exact name of the database they intend to access during the connection setup process.
  • Username: The Username field requires users to input the username associated with their database account. This username is used for authentication purposes when establishing a connection to the database server. It should be provided along with the corresponding password to authorize access to the specified database.
  • Password & Confirm Password: These fields allow users to securely input the password associated with the provided username for accessing the database. Confirming the password ensures accuracy and helps prevent input errors. It's crucial to enter the password correctly to authenticate successfully and establish a secure connection to the database server.
  • Quote Character: The Quote Character field specifies the character used to enclose identifiers in SQL queries, such as table or column names. By default, the double quote (") is commonly used, but users may customize this setting based on their database system's requirements or conventions. It ensures proper parsing and interpretation of identifiers within SQL statements.