Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
By default, the provider projects columns over the properties of objects, including objects nested in objects. Arrays are returned as JSON strings, by default. You can use the following properties to access array elements, including objects nested in arrays.
FlattenArrays: Set this property to the number of array elements that you want to return as column values. You can also use this property with FlattenObjects to extract the properties of objects nested in arrays.
FlattenObjects: By default, this is true; that is, the properties of objects and nested objects are returned as columns. When you set FlattenArrays, objects nested in the specified array elements are also flattened and returned as columns.
You can use the following properties to gain greater control over Cassandra API features and the strategies the provider uses to surface them:
AllowFiltering: Set this property to allow the server to process slow-performing searches.
UseJsonFormat: Set this property to use CQL literals instead of JSON.
QueryPassthrough: This property enables you to use native CQL statements instead of SQL.
RowScanDepth: This property determines the number of rows that will be scanned to detect column data types when generating table metadata. This property applies if you are working with the dynamic schemas generated or if you are using QueryPassthrough.
To obtain the connection string needed to connect to a Cosmos DB account using the SQL API, log in to the Azure Portal, select Azure Cosmos DB, and select your account. In the Settings section, click Connection String and set the following values:
AccountEndpoint: The value should be the Cosmos DB account URL from the Keys blade of the Cosmos DB account.
AccountKey: In the Azure portal, navigate to the Cosmos DB service and select your Azure Cosmos DB account. From the resource menu, go to the Keys page. Find the PRIMARY KEY value and set Token to this value.
TokenType: (Optional) Set this to 'master' if you are using a Master Token, which is a full permissions token generated during account creation. Otherwise, set this property to 'resource' if you are using a Resource Token, which is custom permissions token generated when a database user is set up. The default value is 'master'. Check the TokenType connection property description for more details.
Set the Server and Database connection properties to connect to Cassandra.
To connect to a distributed system, you can set Server to a comma-separated list of servers and ports, separated by colons. You will also need to set ConsistencyLevel.
The following sections detail connection properties for authentication, security, and data access.
To obtain the connection string needed to connect to a Cosmos DB account using the Cassandra API, log in to the Azure Portal, select Azure Cosmos DB, and select your account. In the Settings section, click Connection String and set the following values.
Server: Set this to the Host value, the FQDN of the server provisioned for your account. You can also specify the port here or in Port.
Port: Set this to the port.
Database: Set this to the database you want to read from and write to.
User: The Cosmos DB account name.
Password: The account key associated with the Cosmos DB account.
UseSSL: Set to True
You can use the following properties to gain greater control over Cassandra API features and the strategies the provider uses to surface them:
AllowFiltering: Set this property to allow the server to process slow-performing searches.
UseJsonFormat: Set this property to use CQL literals instead of JSON.
QueryPassthrough: This property enables you to use native CQL statements instead of SQL.
RowScanDepth: This property determines the number of rows that will be scanned to detect column data types when generating table metadata.
This property applies if you are working with the dynamic schemas generated from Automatic Schema Discovery or if you are using QueryPassthrough.
You can set UseSSL to negotiate SSL/TLS encryption when you connect. By default, the provider attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store. To specify another certificate, see the SSLServerCert property for the available formats to do so.
The provider supports Basic authentication with login credentials and the additional authentication features of DataStax Enterprise (DSE) Cassandra. The following sections detail connection properties your authentication method may require.
You need to set AuthScheme to the value corresponding to the authenticator configured for your system. You specify the authenticator in the authenticator property in the cassandra.yaml file. This file is typically found in /etc/dse/cassandra. or through the DSE Unified Authenticator on DSE Cassandra.
Basic authentication is supported through Cassandra's built-in default PasswordAuthenticator.
Set the AuthScheme property to 'BASIC' and set the User and Password properties.
In the cassandra.yaml file, set the authenticator property to 'PasswordAuthenticator'.
Kerberos authentication is supported through DataStax Enterprise Unified Authentication.
Set the AuthScheme property to 'KERBEROS' and set the User and Password properties.
Set the KerberosKDC, KerberosRealm, and KerberosSPN properties.
In the cassandra.yaml file, set the authenticator property to "com.datastax.bdp.cassandra.auth.DseAuthenticator".
Modify the authentication_options section in the dse.yaml file, specifying the default_schema and other_schemas properties as 'kerberos'.
Modify the kerberos_options section in the dse.yaml file, specifying the keytab, service_principle, http_principle and qop properties
To authenticate to Cassandra using Kerberos, set the following properties:
AuthScheme: Set this to KERBEROS
KerberosKDC: Set this to the host name or IP Address of your Kerberos KDC machine.
KerberosSPN: Set this to the service and host of the Cassandra Kerberos Principal. This will be the value prior to the '@' symbol (for instance, hbase/MyHost) of the principal value (for instance, hbase/MyHost@EXAMPLE.COM).
You can use one of the following options to retrieve the required Kerberos ticket.
This option enables you to use the MIT Kerberos Ticket Manager or kinit command to get tickets. Note that you won't need to set the User or Password connection properties with this option.
Ensure that you have an environment variable created called KRB5CCNAME.
Set the KRB5CCNAME environment variable to a path pointing to your credential cache file (for instance, C:\krb_cache\krb5cc_0 or /tmp/krb5cc_0). This file will be created when generating your ticket with MIT Kerberos Ticket Manager.
To obtain a ticket, open the MIT Kerberos Ticket Manager application, click Get Ticket, enter your principal name and password, then click OK. If successful, ticket information will appear in Kerberos Ticket Manager and will now be stored in the credential cache file.
Now that the credential cache file has been created, the provider will use the cache file to obtain the kerberos ticket to connect to Cassandra.
As an alternative to setting the KRB5CCNAME environment variable, you can directly set the file path using the KerberosTicketCache property. When set, the provider will use the specified cache file to obtain the kerberos ticket to connect to Cassandra.
If the KRB5CCNAME environment variable has not been set, you can retrieve a Kerberos ticket using a Keytab File. To do this, set the User property to the desired username and set the KerberosKeytabFile property to a file path pointing to the keytab file associated with the user.
If both the KRB5CCNAME environment variable and the KerberosKeytabFile property have not been set, you can retrieve a ticket using a User and Password combination. To do this, set the User and Password properties to the user/password combo that you use to authenticate with Cassandra.
More complex Kerberos environments may require cross-realm authentication where multiple realms and KDC servers are used (e.g. where one realm/KDC is used for user authentication and another realm/KDC used for obtaining the service ticket).
In such an environment, the KerberosRealm and KerberosKDC properties can be set to the values required for user authentication. The KerberosServiceRealm and KerberosServiceKDC properties can be set to the values required to obtain the service ticket.
LDAP authentication is supported through DataStax Enterprise Unified Authentication.
Set the AuthScheme property to 'LDAP' and set the User and Password properties.
In the cassandra.yaml file, set the authenticator property to "com.datastax.bdp.cassandra.auth.DseAuthenticator".
Modify the authentication_options section in the dse.yaml file, specifying the default_schema and other_schemas properties as 'ldap'.
Modify the ldap_options section in the dse.yaml file, specifying the server_host, server_port, search_dn, search_password, user_search_base, and user_search_filter properties
You can specify a client certificate to authenticate the provider with SSLClientCert, SSLClientCertType, SSLClientCertSubject, and SSLClientCertPassword.
The following are the connection properties for Cassandra. Not all properties are required. Enter only property values pertaining to your installation. Several properties will be automatically initialized with the appRules defaults.
Property
Description
Authentication
AuthScheme
The scheme used for authentication. Accepted entries are BASIC, DSE, KERBEROS, and LDAP.
DefaultLDAPUser
The default LDAP user used to connect to and communicate with the server, it must be set if the LDAP server do not allow anonymous bind.
LDAPPassword
The password of the default LDAP user. It must be set if the LDAP server do not allow anonymous bind.
LDAPPort
The port for the LDAP server.
LDAPServer
The host name or IP address of the LDAP server.
Password
The password used to authenticate with Cassandra.
Port
The port for the Cassandra database.
SearchBase
The search base for your LDAPServer, used to look up users.
SearchFilter
The search filter for looking up usernames in LDAP. The default setting is (uid=), When using Active Directory set the filter to (sAMAccountName=).
Server
The host name or IP address of the server hosting the Cassandra database.
User
The username used to authenticate with Cassandra.
UseSSL
This field sets whether SSL is enabled.
Database
Database
The name of the Cassandra keyspace.
Firewall
FirewallPassword
A password used to authenticate to a proxy-based firewall.
FirewallPort
The TCP port for a proxy-based firewall.
FirewallServer
The name or IP address of a proxy-based firewall.
FirewallType
The protocol used by a proxy-based firewall.
FirewallUser
The user name to use to authenticate with a proxy-based firewall.
Kerberos
KerberosKDC
The Kerberos Key Distribution Center (KDC) service used to authenticate the user.
KerberosRealm
The Kerberos Realm used to authenticate the user with.
KerberosSPN
The service principal name (SPN) for the Kerberos Domain Controller.
Logging
Logfile
A path to the log file.
MaxLogFileCount
A string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted.
MaxLogFileSize
A string specifying the maximum size in bytes for a log file (for example, 10 MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end.
Verbosity
The verbosity level that determines the amount of detail included in the log file.
Misc
AggregationsSupported
Whether or not to support aggregations in the Cassandra server. Note that in queries to the provider, you must use single quotes to define strings.
AllowFiltering
When true, slow-performing queries are processed on the server.
CaseSensitivity
Enable case sensitivity to the CQL sending to the server, if set to True, the identifiers in the CQL will be enclosed in double quotation marks.
ConnectionLifeTime
The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed.
ConnectionString
***
ConsistencyLevel
The consistency level determines how many of the replicas of the data you are interacting with need to respond for the query to be considered a success.
FlattenArrays
By default, nested arrays are returned as strings of JSON. The FlattenArrays property can be used to flatten the elements of nested arrays into columns of their own. Set FlattenArrays to the number of elements you want to return from nested arrays.
FlattenObjects
Set FlattenObjects to true to flatten object properties into columns of their own. Otherwise, objects nested in arrays are returned as strings of JSON.
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.
NullToUnset
Use unset instead of NULL in CQL query when performing INSERT operations.
Other
These hidden properties are used only in specific use cases.
Pagesize
The maximum number of results to return per page from Cassandra Server.
PoolIdleTimeout
The allowed idle time for a connection before it is closed.
PoolMaxSize
The maximum connections in the pool.
PoolMinSize
The minimum number of connections in the pool.
PoolWaitTime
The max seconds to wait for an available connection.
PseudoColumns
This property indicates whether or not to include pseudo columns as columns to the table.
QueryPassthrough
This option passes the query to the Cassandra server as is.
Readonly
You can use this property to enforce read-only access to Cassandra from the provider.
RowScanDepth
The maximum number of rows to scan to look for the columns available in a table. Set this property to gain more control over how the provider applies data types to collections.
SSLServerCert
The certificate to be accepted from the server when connecting using TLS/SSL.
SupportEnhancedSQL
This property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing.
Timeout
The value in seconds until the timeout error is thrown, canceling the operation.
UseConnectionPooling
This property enables connection pooling.
UseJsonFormat
Whether to submit and return the JSON encoding for CQL data types.
VarintToString
Map Cassandra VARINT to String value.
SSL
SSLClientCert
The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
SSLClientCertPassword
The password for the TLS/SSL client certificate.
SSLClientCertSubject
The subject of the TLS/SSL client certificate.
SSLClientCertType
The type of key store containing the TLS/SSL client certificate.
Set the following connection properties to connect to a single MongoDB instance:
Server: Set this to the name or address of the server your MongoDB instance is running on. You can specify the port here or in Port.
Database: Set this to the database you want to read from and write to.
To obtain the connection string needed to connect to a Cosmos DB account using the MongoDB API, log in to the Azure Portal, select Azure Cosmos DB, and select your account. In the Settings section, click Connection String and set the following values.
Server: Set this to the Host value, the FQDN of the server provisioned for your account. You can also specify the port here or in Port.
Port: Set this to the port.
Database: Set this to the database you want to read from and write to.
User: Set this to the database user.
Password: Set this to the user's password.
To connect to a replica set, set the following in addition to the preceding connection properties:
ReplicaSet: Set this to a comma-separated list of secondary servers in the replica set, specified by address and port.
SlaveOK: Set this to true if you want to read from secondary (slave) servers.
ReadPreference: Set this to fine-tune how the provider reads from secondary servers.
Before you can connect to Amazon DocumentDB, you will first need to, ensure your Amazon DocumentDB cluster and the EC2 instance containing the mongo shell are currently running.
Next, configure an SSH tunnel to the EC2 instance as follows.
From the AWS management console, select Services -> Database -> Amazon DocumentDB. From the DocumentDB management page, select Clusters, then click your cluster.
Under the Connect section, note the --host value and its port found in the sample connection string.
Navigate to Services -> Compute -> EC2. Select Running instances.
Select your instance, then click the Connect button.
Under the Example section, note the value identifying the instance and user, shown in the form <ami_username>@<Public DNS>
In your preferred SSH client, establish a connection to your EC2 instance using the Host Name from the EC2 instance's Connect page (username@publicDNS) and Port 22.
Provide your EC2 instance's private key file (in Putty, you will need to convert the keys from .pem to .ppk) for authentication.
Configure an SSH tunnel using the port and host name from the DocumentDB cluster page.
Establish the connection to the EC2 virtual machine.
After specify the following to connect to the DocumentDB cluster.
Server: Set this to the machine name which is hosting the SSH tunnel.
Port: Set this to the port the SSH tunnel is hosted on.
User: Set this to the master username used to provision the DocumentDB cluster.
Password: Set this to the master password set when provisioning the DocumentDB cluster.
UseSSL: Set this to true.
UseFindAPI Set this to true.
You can set UseSSL to negotiate SSL/TLS encryption when you connect.
Supported authentication types are challenge-response authentication and LDAP.
In challenge-response authentication, the User and Password properties correspond to a username and password stored in a MongoDB database. If you want to connect to data from one database and authenticate to another database, set both Database and AuthDatabase.
To use LDAP authentication, set AuthDatabase to "$external" and set AuthMechanism to PLAIN. This value specifies the SASL PLAIN mechanism; note that this mechanism transmits credentials over plaintext, so it is not suitable for use without TLS/SSL on untrusted networks.
Set the Server connection property to the name or address of the server your Redis instance is running on.
If your Redis server is running on a port other than the default (6379), you can specify your port in the Port property.
The provider supports Password and ACL authentication. Connections to Redis instances that aren't password protected are supported as well.
Set the AuthScheme property to None. This indicates the Redis instance is not password protected (using the requirepass directive in the configuration file).
Set the AuthScheme property to Password and set the Password property to the password used to authenticate with a password protected Redis instance using the Redis AUTH command.
Set the following to connect:
AuthScheme: Set this to ACL.
User: Set this to the username you use to authenticate with Redis ACL.
Password: Set this to the password you use to authenticate with Redis ACL.
You can set UseSSL to negotiate SSL/TLS encryption when you connect.
Specify the following to connect to data:
Domain: Set this if you want to use a domain name you have associated with AWS.
AWSRegion: Set this to the region where your Amazon DynamoDB data is hosted.
To obtain the credentials for an IAM user, follow the steps below:
Sign into the IAM console.
In the navigation pane, select Users.
To create or manage the access keys for a user, select the user and then select the Security Credentials tab.
To obtain the credentials for your AWS root account, follow the steps below:
Sign into the AWS Management console with the credentials for your root account.
Select your account name or number and select My Security Credentials in the menu that is displayed.
Click Continue to Security Credentials and expand the Access Keys section to manage or create root account access keys.
To authenticate using account root credentials, set the following:
AuthScheme: Set this to AwsRootKeys.
AWSAccessKey: The access key associated with the AWS root account.
AWSSecretKey: The secret key associated with the AWS root account.
Note: Use of this authentication scheme is discouraged by Amazon for anything but simple tests. The account root credentials have the full permissions of the user, making this the least secure authentication method.
To authenticate using temporary credentials, specify the following:
AuthScheme: Set this to TemporaryCredentials.
AWSAccessKey: The access key of the IAM user to assume the role for.
AWSSecretKey: The secret key of the IAM user to assume the role for.
AWSSessionToken: Your AWS session token. This will have been provided alongside your temporary credentials. See this link for more info.
The provider can now request resources using the same permissions provided by long-term credentials (such as IAM user credentials) for the lifespan of the temporary credentials.
If you are also using an IAM role to authenticate, you must additionally specify the following:
AWSRoleARN: Specify the Role ARN for the role you'd like to authenticate with. This will cause the provider to attempt to retrieve credentials for the specified role.
AWSExternalId: Only if required when you assume a role in another account.
If you are using the provider from an EC2 Instance and have an IAM Role assigned to the instance, you can use the IAM Role to authenticate. To do so, set the following properties to authenticate:
AuthScheme: Set this to AwsEC2Roles.
Do not specify AWSAccessKey and AWSSecretKey because the provider will automatically obtain your IAM Role credentials and authenticate with them.
If you are also using an IAM role to authenticate, you must additionally specify the following:
AWSRoleARN: Specify the Role ARN for the role you'd like to authenticate with. This will cause the provider to attempt to retrieve credentials for the specified role.
AWSExternalId: Only if required when you assume a role in another account.
In many situations it may be preferable to use an IAM role for authentication instead of the direct security credentials of an AWS root user.
To authenticate as an AWS role, set the following:
AuthScheme: Set this to AwsIAMRoles.
AWSRoleARN: Specify the Role ARN for the role you'd like to authenticate with. This will cause the provider to attempt to retrieve credentials for the specified role.
AWSExternalId: Only if required when you assume a role in another account.
AWSAccessKey: The access key of the IAM user to assume the role for.
AWSSecretKey: The secret key of the IAM user to assume the role for.
Note: Roles may not be used when specifying the AWSAccessKey and AWSSecretKey of an AWS root user.
Set the AuthScheme to ADFS. The following connection properties need to be set:
User: Set this to the ADFS user.
Password: Set this to ADFS password for the user.
SSOLoginUrl: Set this to the login url used by the SSO provider.
The ADFS Integrated flow indicates you are connecting with the currently logged in Windows user credentials. To use the ADFS Integrated flow, simply do not specify the User and Password, but otherwise follow the same steps in the ADFS guide above.
Set the AuthScheme to Okta. The following connection properties are used to connect to Okta:
User: Set this to the Okta user.
Password: Set this to Okta password for the user.
SSOLoginUrl: Set this to the login url used by the SSO provider.
The following SSOProperties are needed to authenticate to Okta:
APIToken (optional): Set this to the API Token that the customer created from the Okta org. It should be used when authenticating a user via a trusted application or proxy that overrides OKTA client request context.
Set the AuthScheme to PingFederate. The following connection properties need to be set:
User: Set this to the PingFederate user.
Password: Set this to PingFederate password for the user.
SSOLoginUrl: Set this to the login url used by the SSO provider.
SSOExchangeUrl: The 'Partner Service Identifier' URI configured in your PingFederate server instance under: SP Connections > SP Connection > WS-Trust > Protocol Settings. This should uniquely identify a PingFederate SP Connection, so it is a good idea to set it to your 'AWS SSO ACS URL'. You can find it under AWS SSO > Settings > Click on 'View Details' next to the Authentication field.
The following SSOProperties are needed to authenticate to PingFederate:
AuthScheme (optional): The authorization scheme to be used for the IdP endpoint. The allowed values for this IdP are None or Basic.
Additionally, you can use the following SSOProperties to configure mutual SSL authentication for SSOLoginUrl, the WS-Trust STS endpoint:
SSLClientCert
SSLClientCertType
SSLClientCertSubject
SSLClientCertPassword
For users and roles that require Multi-factor Authentication, specify the following to authenticate:
AuthScheme: Set this to AwsMFA.
CredentialsLocation: The location of the settings file where MFA credentials are saved. See the Credentials File Location page under Connection String Options for more information.
MFASerialNumber: The serial number of the MFA device if one is being used.
MFAToken: The temporary token available from your MFA device.
If you are connecting to AWS (instead of already being connected such as on an EC2 instance), you must additionally specify the following:
AWSAccessKey: The access key of the IAM user for whom MFA will be issued.
AWSSecretKey: The secret key of the IAM user whom MFA will be issued.
If you are also using an IAM role to authenticate, you must additionally specify the following:
AWSRoleARN: Specify the Role ARN for the role you'd like to authenticate with. This will cause the provider to attempt to retrieve credentials for the specified role using MFA.
AWSExternalId: Only if required when you assume a role in another account.
This will cause the provider to submit the MFA credentials in a request to retrieve temporary authentication credentials.
Note that the duration of the temporary credentials may be controlled via the TemporaryTokenDuration property (default 3600 seconds).
You may use a credentials file to authenticate. Any configurations related to AccessKey/SecretKey authentication, temporary credentials, role authentication, or MFA will be used. To do so, set the following properties to authenticate:
AuthScheme: Set this to AwsCredentialsFile.
AWSCredentialsFile: Set this to the location of your credentials file.
AWSCredentialsFileProfile: Optionally set this to the name of the profile you would like to use from the specified credentials file. If not specified, the profile with the name default will be used.
The following are the connection properties for Amazon DynamoDB. Not all properties are required. Enter only property values pertaining to your installation. Several properties will be automatically initialized with the appRules defaults.
There are two authentication methods available for connecting to Cloudant: IBM Cloudant Legacy and IBM Cloud IAM.
Set the User and Password to your service credentials.
To create an IBM Cloudant service credential:
In the IBM Cloud dashboard, go to the Menu icon > Resource List, and open your IBM Cloudant service instance.
In the menu, click Service credentials.
Click New credential and enter a name for the new credential in the Add new credential window.
Click Add. This adds your credentials to the Service credentials table.
Click Actions > View credentials and extract the User and Password from the JSON file.
To connect with IBM Cloud, you will need the ApiKey and the Url of Cloudant instance ( i.e https://0c9d3837-8304-4aab-a65a-648169970943-bluemix.cloudant.com). After setting InitiateOAuth to GETANDREFRESH (default), you are ready to connect.
When you connect, the provider completes the OAuth process.
Extracts the access token and authenticates requests.
Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
After you have created an account in IBM Cloud you should follow the procedure below to retrieve the connection properties:
To obtain the ApiKey, take the following steps:
Log in to your IBM Cloud account.
On the middle right corner click "Create an IBM Cloud API Key" in order to create a new API Key.
In the pop-up window, specify the API Key name and click "Create". Save the ApiKey somewhere as you can never access it again from the dashboard.
If you do not already have Cloud Object Storage in your IBM Cloud account, you can follow the procedure below to install an instance of SQL Query in your account:
Log in to your IBM Cloud account.
We support Local instances from version 1.1.0 and above.
To authenticate to your local instance:
Url: Set to the Url of your local instance. For example: http://localhost:8006
To connect to data, set the Server property to the hostname or IP address of the Couchbase server(s) you are authenticating to. If your Couchbase server is configured to use SSL, you can enable it either by using an https URL for Server (like 'https://couchbase.server'), or by setting the UseSSL property to True.
By default, the provider connects to the N1QL Query service. In order to connect to the Couchbase Analytics service, you will also need to set the CouchbaseService property to Analytics.
A few special settings are required to connect to Couchbase Cloud:
Set the AuthScheme to Basic
Set the Server option to the domain listed in the Couchbase Cloud console.
Enable the UseSSL option.
Set the ConnectionMode to Cloud
Set the DNSServer option to a DNS server. In most cases this should be a public DNS service like 1.1.1.1 or 8.8.8.8.
Set the SSLServerCert option to * to trust the Couchbase server certificate. You can also provide the certificate using that option or your trust store if you want the provider to validate it.
The provider supports several forms of authentication depending upon how your Couchbase Server is configured. Couchbase Cloud only accepts Standard Authentication, while Couchbase Server accepts all forms.
To authenticate with standard authentication, set the following:
AuthScheme: Use the Basic option.
User: The user authenticating to Couchbase.
Password: The password of the user authenticating to Couchbase.
The provider supports authenticating with client certificates when SSL is enabled. To use client certificate authentication, set the following properties.
AuthScheme: Required. Use the SSLCertificate option.
SSLClientCertType: Required. The type of client certificate set within SSLClientCert.
SSLClientCert: Required. The client certificate in the format given by SSLClientCertType. Usually the path to your private key file.
SSLClientCertPassword: Optional. The password of the client certificate if it is encrypted.
SSLClientCertSubject: Optional. The subject of the client certificate, by default the first certificate found in the store. This is required if more than one certificate is available in the certificate store.
You can also authenticate using using a credentials file containing multiple logins. This is included for legacy use and is not recommended when connecting to a Couchbase Server that supports role-based authentication.
AuthScheme: Use the CredentialsFile option.
The following are the connection properties for Couchbase. Not all properties are required. Enter only property values pertaining to your installation. Several properties will be automatically initialized with the appRules defaults.
Navigate to page.
Navigate to the page, choose a name for your instance and click Create. You will be redirected to the instance of Cloudant.
CredentialsFile; The path to the credentials file. Refer to for more information on the format of this file.
Property
Description
Authentication
AccessKey
Your AWS account access key. This value is accessible from your AWS security credentials page.
Domain
Your AWS domain name. You can optionally choose to associate your domain name with AWS.
MFASerialNumber
The serial number of the MFA device if one is being used.
MFAToken
The temporary token available from your MFA device.
Region
The hosting region for your Amazon Web Services.
RoleARN
The optional Amazon Resource Name of the role to use when authenticating.
SecretKey
Your AWS account secret key. This value is accessible from your AWS security credentials page.
TemporaryTokenDuration
The amount of time (in seconds) a temporary token will last.
URL
The URL to use when submitting requests. This should not normally need to be set.
UseEC2Roles
A boolean indicating if you would like to use EC2 credentials.
Caching
AutoCache
Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .
CacheConnection
The connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data.
CacheLocation
Specifies the path to the cache when caching to a file.
CacheMetadata
This property determines whether or not to cache the table metadata to a file store.
CacheProvider
The name of the provider to be used to cache data.
CacheTolerance
The tolerance for stale data in the cache specified in seconds when using AutoCache .
Offline
Use offline mode to get the data from the cache instead of the live source.
Firewall
FirewallPassword
A password used to authenticate to a proxy-based firewall.
FirewallPort
The TCP port for a proxy-based firewall.
FirewallServer
The name or IP address of a proxy-based firewall.
FirewallType
The protocol used by a proxy-based firewall.
FirewallUser
The user name to use to authenticate with a proxy-based firewall.
Logging
Logfile
A path to the log file.
MaxLogFileCount
A string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted.
MaxLogFileSize
A string specifying the maximum size in bytes for a log file (for example, 10 MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end.
Verbosity
The verbosity level that determines the amount of detail included in the log file.
Misc
AutoDetectIndex
A boolean indicating if secondary indexes should be automatically detected based on the query used.
BufferSize
Determines the internal buffer size to fill up to before returning results.
ConnectionLifeTime
The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed.
ConnectionString
***
CredentialsFileLocation
The location of the settings file where MFA credentials are saved.
FlattenArrays
By default, nested arrays are returned as strings of JSON. The FlattenArrays property can be used to flatten the elements of nested arrays into columns of their own. Set FlattenArrays to the number of elements you want to return from nested arrays.
FlattenObjects
Set FlattenObjects to true to flatten object properties into columns of their own. Otherwise, objects nested in arrays are returned as strings of JSON.
GenerateSchemaFiles
Indicates the user preference as to when schemas should be generated and saved.
InsertMode
How to handle values when inserting if the same primary key combination already exists in DynamoDB.
MaximumRequestRetries
The maximum number of times to retry a request.
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.
NumberColumnMode
Specifies how to handle detected number columns. DynamoDB returns number values with a total precision of 38.
Other
These hidden properties are used only in specific use cases.
Pagesize
The maximum number of results to return per page from DynamoDB per request.
PoolIdleTimeout
The allowed idle time for a connection before it is closed.
PoolMaxSize
The maximum connections in the pool.
PoolMinSize
The minimum number of connections in the pool.
PoolWaitTime
The max seconds to wait for an available connection.
PseudoColumns
This property indicates whether or not to include pseudo columns as columns to the table.
Readonly
You can use this property to enforce read-only access to Amazon DynamoDB from the provider.
RetryWaitTime
The minimum number of milliseconds the provider will wait to retry a request.
RowScanDepth
The maximum number of rows to scan to look for the columns available in a table.
SeparatorCharacter
The character or characters used to denote hierarchy.
SSLServerCert
The certificate to be accepted from the server when connecting using TLS/SSL.
SupportEnhancedSQL
This property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing.
ThreadCount
The number of threads to use when selecting data via a parallel scan. Setting ThreadCount to 1 will disable parallel scans.
Timeout
The value in seconds until the timeout error is thrown, canceling the operation.
TypeDetectionScheme
Determines how to determine the data type of columns.
UseConnectionPooling
This property enables connection pooling.
UseSimpleNames
Boolean determining if simple names should be used for tables and columns.
Proxy
ProxyAuthScheme
The authentication type to use to authenticate to the ProxyServer proxy.
ProxyAutoDetect
This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
ProxyExceptions
A semicolon separated list of hosts or IPs that are exempt from connecting through the ProxyServer .
ProxyPassword
A password to be used to authenticate to the ProxyServer proxy.
ProxyPort
The TCP port the ProxyServer proxy is running on.
ProxyServer
The hostname or IP address of a proxy to route HTTP traffic through.
ProxySSLType
The SSL type to use when connecting to the ProxyServer proxy.
ProxyUser
A user name to be used to authenticate to the ProxyServer proxy.
Schema
Location
A path to the directory that contains the schema files defining tables, views, and stored procedures.
Tables
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Property
|
Description
|
Authentication |
AnalyticsPort | The port for connecting to the Couchbase Analytics Endpoint. |
CouchbaseService | Determines the Couchbase service to connect to. Default is N1QL. Available options are N1QL and Analytics. |
CredentialsFile | Use this property if you need to provide credentials for multiple users or buckets. This file takes priority over other forms of authentication. |
N1QLPort | The port for connecting to the Couchbase N1QL Endpoint. |
Password | The password used to authenticate to Couchbase. |
Server | The address of the Couchbase server or servers to which you are connecting. |
User | The user who is authenticating to Couchbase. |
UseSSL | Whether to negotiate TLS/SSL when connecting to the Couchbase server. |
WebConsolePort | The port for connecting to the Couchbase Web Console. |
Data |
SupportEnhancedSQL | If the property is set to true, allow the provider to perform queries client-side when Couchbase does not support them. |
Firewall |
FirewallPassword | A password used to authenticate to a proxy-based firewall. |
FirewallPort | The TCP port for a proxy-based firewall. |
FirewallServer | The name or IP address of a proxy-based firewall. |
FirewallType | The protocol used by a proxy-based firewall. |
FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
Logging |
Logfile | A path to the log file. |
MaxLogFileCount | A string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted. |
MaxLogFileSize | A string specifying the maximum size in bytes for a log file (for example, 10 MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end. |
Verbosity | The verbosity level that determines the amount of detail included in the log file. |
Misc |
AllowJSONParameters | Allows raw JSON to be used in parameters when QueryPassthrough is enabled. |
ChildSeparator | The character or characters used to denote child tables. |
ConnectionLifeTime | The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. |
ConnectionString | *** |
CreateTableRamQuota | The default RAM quota, in megabytes, to use when inserting buckets via the CREATE TABLE syntax. |
Dataverse | Which Analytics dataverse to scan when discovering tables. |
DataverseSeparator | The character or characters used to denote Analytics dataverses. |
FlattenArrays | By default, nested arrays are returned as strings of JSON. The FlattenArrays property can be used to flatten the elements of nested arrays into columns of their own. Set FlattenArrays to the number of elements you want to return from nested arrays. |
FlattenObjects | Set FlattenObjects to true to flatten object properties into columns of their own. Otherwise, objects nested in arrays are returned as strings of JSON. |
FlavorSeparator | The character or characters used to denote flavors. |
GenerateSchemaFiles | Indicates the user preference as to when schemas should be generated and saved. |
InferNumSampleValues | The maximum number of values for every field to scan before determining its data type. Applies to Automatic Schema Discovery when TypeDetectionScheme is set to INFER. |
InferSampleSize | The maximum number of documents to scan for the columns available in the bucket. Applies to Automatic Schema Discovery when TypeDetectionScheme is set to INFER. |
InferSimilarityMetric | Specifies the similarity degree where different schemas will be considered to be the same flavor. Applies to Automatic Schema Discovery when TypeDetectionScheme is set to INFER. |
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. |
PageSize | The number of results to return per page of data retrieved from the Couchbase server. |
PeriodsSeparator | The character or characters used to denote hierarchy. |
PoolIdleTimeout | The allowed idle time for a connection before it is closed. |
PoolMaxSize | The maximum connections in the pool. |
PoolMinSize | The minimum number of connections in the pool. |
PoolWaitTime | The max seconds to wait for an available connection. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
QueryExecutionTimeout | This sets the server-side timeout for the query, which governs how long Couchbase will execute the query before returning a timeout error. |
QueryPassthrough | This option passes the query to the Couchbase server as is. |
Readonly | You can use this property to enforce read-only access to Couchbase from the provider. |
RowScanDepth | The maximum number of documents to scan for the columns available in the bucket. |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
StrictComparison | Adjusts how precisely to translate filters on SQL input queries into Couchbase queries. This can be set to a comma-separated list of values, where each value can be one of: date, number, boolean, or string. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
TypeDetectionScheme | Determines how the provider builds tables and columns from the buckets found in Couchbase. |
UseConnectionPooling | This property enables connection pooling. |
ValidateJSONParameters | Allows the provider to validate that string parameters are valid JSON before sending the query to Couchbase. |
Proxy |
ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
ProxyAutoDetect | This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings. |
ProxyExceptions | A semicolon separated list of hosts or IPs that are exempt from connecting through the ProxyServer . |
ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
ProxyPort | The TCP port the ProxyServer proxy is running on. |
ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
Schema |
TableSupport | How much effort the provider will put into discovering tables on the Couchbase server. |