Database Server Connection Editor

Reference documentation for the DB Server Connection editor

The Database Server Connection Editor in Servoy allows developers to create and manage database connections efficiently. To access the editor, right-click the Database Servers node in the Solution Explorer and select either "Connect to Existing Database" or "Create PostgreSQL Database." You can configure server name, host name, database name, and credentials. The editor also provides options for testing connections and saving configurations. This tool enables you to connect to existing databases or create new ones directly within Servoy.

Below is a brief explanation of each option available in the editor:

  • Server name: A unique identifier for the database server connection within Servoy. This name is used in data bindings and scripts to reference this particular connection.

  • Host name: The address of the database server, which can be a domain name or an IP address. Examples include localhost or for local connections.

  • User name: The database user account that has the necessary permissions to access the specified database.

  • Database name: The specific database on the server that you wish to connect to.

  • Password: The password for the specified user account, used to authenticate the connection.

  • URL: The JDBC URL string used to establish the database connection, formatted as per the specific database vendor's requirements.

    • Driver: Specifies the JDBC driver class required to connect to the database.

    • Catalog: Optional setting for selecting a specific catalog within the database, used for organizational purposes.

    • Schema: Optional setting for specifying the schema within the database, useful for environments with multiple schemas.

    • Max Active Connections: Limits the number of simultaneous active connections to the database, helping to manage resource usage.

    • Max Idle Connections: Sets the maximum number of idle connections that can be retained for reuse, optimizing performance.

    • Connection Idle Timeout: Defines the timeout duration for idle connections, after which they will be closed.

    • Max Idle Prepared Statements: Specifies the maximum number of pre-compiled SQL statements that can be kept idle.

    • Connection Validation Type: Determines the method used to validate connections (e.g., checking for exceptions) to ensure they are still alive and functional.

    • Connection Validation Query: A SQL query used to test the validity of connections, ensuring they can still communicate with the database.

    • Data model clone from: Allows cloning the data model configuration from another source, simplifying setup in similar environments.

    • Enabled: Toggles the database connection on or off, enabling or disabling access to the database.

    • Prefix Tables: Adds a specified prefix to all table names in this connection, useful for namespace management.

    • Log Table Name: Specifies the name of the table where log entries will be stored if logging is enabled.

    • Create Log Table: A command to create the log table in the database if it does not already exist.

    • Client Only Connections: Restricts the database connection to client-side use only, enhancing security.

    • Sorting null-precedence: Defines how null values should be handled in sorting operations, according to database-specific rules or preferences.

    • Skip System Tables: Excludes system tables from the connection, focusing only on user-defined tables.

    • Log Server: Enables logging of server activities related to this database connection, useful for debugging and monitoring. Enable procedures:** Allows the use of stored procedures within the connected database, expanding functionality.

    • Sort ignoring case: Enables case-insensitive sorting, which can be important for certain applications and data sets.

For detailed instructions and comprehensive information, refer to the Databases section of the documentation. This section covers everything from setting up database connections and configuring connection properties to creating new databases and managing advanced settings. It explains how to blend data from various sources, build data-bound user interfaces, and execute logic against data models. Additionally, it provides guidance on deploying database connections across development, testing, and production environments.

Last updated