Connection String Options
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Basic Tab.
| Property | Description |
| Server | The host name or IP address of the server. |
| Database | The name of the AlloyDB database. |
| User | The AlloyDB user account used to authenticate. |
| Password | The password used to authenticate the user. |
| Port | The port number of the AlloyDB server. |
| UseSSL | This field sets whether SSL is enabled. |
| Visibility | Visibility restrictions used to filter exposed metadata for tables with privileges granted to them for the current user. |
| Property | Description |
| KerberosKDC | The Kerberos Key Distribution Center (KDC) service used to authenticate the user. |
| KerberosRealm | The Kerberos Realm used to authenticate the user. |
| KerberosSPN | The service principal name (SPN) for the Kerberos Domain Controller. |
| KerberosKeytabFile | The Keytab file containing your pairs of Kerberos principals and encrypted keys. |
| KerberosServiceRealm | The Kerberos realm of the service. |
| KerberosServiceKDC | The Kerberos KDC of the service. |
| KerberosTicketCache | The full file path to an MIT Kerberos credential cache file. |
| Property | Description |
| SSLClientCert | The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). |
| SSLClientCertType | The type of key store containing the TLS/SSL client certificate. |
| SSLClientCertPassword | The password for the TLS/SSL client certificate. |
| SSLClientCertSubject | The subject of the TLS/SSL client certificate. |
| SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| SSHAuthMode | The authentication method to be used to log on to an SFTP server. |
| SSHClientCert | A private key to be used for authenticating the user. |
| SSHClientCertPassword | The password of the SSHClientCert key if it has one. |
| SSHClientCertSubject | The subject of the SSH client certificate. |
| SSHClientCertType | The type of SSHClientCert private key. |
| SSHServer | The SSH server. |
| SSHPort | The SSH port. |
| SSHUser | The SSH user. |
| SSHPassword | The SSH password. |
| SSHServerFingerprint | The SSH server fingerprint. |
| UseSSH | Whether to tunnel the AlloyDB connection over SSH. Use SSH. |
| Property | Description |
| FirewallType | The protocol used by a proxy-based firewall. |
| FirewallServer | The name or IP address of a proxy-based firewall. |
| FirewallPort | The TCP port for a proxy-based firewall. |
| FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
| FirewallPassword | A password used to authenticate to a proxy-based firewall. |
| Property | Description |
| LogModules | Core modules to be included in the log file. |
| Property | Description |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| IgnoredSchemas | Visibility restriction filter which is used to hide schemas from the list of schemas obtained by querying metadata. For example, 'information_schema, pg_catalog'. Schema names are case sensitive. |
| Property | Description |
| AllowPreparedStatement | Prepare a query statement before its execution. |
| BrowsePartitions | By default, the provider exposes the super table and its partitions by metadata. You may hide sub partitions by setting this property to false. |
| FetchResultSetMetadata | This field sets whether the provider retrieves metadata pertaining to the schema and table name for resultset columns returned by the server. |
| IncludeTableTypes | If set to true, the provider will query for the types of individual tables and views. |
| MaxRows | Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time. |
| Other | These hidden properties are used only in specific use cases. |
| Readonly | You can use this property to enforce read-only access to AlloyDB from the provider. |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| TimeZone | Notifies the server about the timezone on the client with a standard SET TIMEZONE query when a connection is being opened. |