Connection String Parameters for Amazon DynamoDB
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.
Name | Description |
Access Key | Your AWS account access key. This value is accessible from your AWS security credentials page. |
Auto Cache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
Auto Detect Index | A boolean indicating if secondary indexes should be automatically detected based on the query used. |
Buffer Size | Determines the internal buffer size to fill up to before returning results. |
Cache Connection | 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. |
Cache Location | Specifies the path to the cache when caching to a file. |
Cache Metadata | This property determines whether or not to cache the table metadata to a file store. |
Cache Provider | The name of the provider to be used to cache data. |
Cache Tolerance | The tolerance for stale data in the cache specified in seconds when using AutoCache . |
Connection Life Time | The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. |
Credentials File Location | The location of the settings file where MFA credentials are saved. |
Domain | Your AWS domain name. You can optionally choose to associate your domain name with AWS. |
Firewall Password | A password used to authenticate to a proxy-based firewall. |
Firewall Port | The TCP port for a proxy-based firewall. |
Firewall Server | The name or IP address of a proxy-based firewall. |
Firewall Type | The protocol used by a proxy-based firewall. |
Firewall User | The user name to use to authenticate with a proxy-based firewall. |
Flatten Arrays | 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. |
Flatten Objects | Set FlattenObjects to true to flatten object properties into columns of their own. Otherwise, objects nested in arrays are returned as strings of JSON. |
Generate Schema Files | Indicates the user preference as to when schemas should be generated and saved. |
Insert Mode | How to handle values when inserting if the same primary key combination already exists in DynamoDB. |
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
Logfile | A path to the log file. |
Maximum Request Retries | The maximum number of times to retry a request. |
Max Log File Count | 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. |
Max Log File Size | 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. |
Max Rows | 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. |
MFA Serial Number | The serial number of the MFA device if one is being used. |
MFA Token | The temporary token available from your MFA device. |
Number Column Mode | Specifies how to handle detected number columns. DynamoDB returns number values with a total precision of 38. |
Offline | Use offline mode to get the data from the cache instead of the live source. |
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. |
Pool Idle Timeout | The allowed idle time for a connection before it is closed. |
Pool Max Size | The maximum connections in the pool. |
Pool Min Size | The minimum number of connections in the pool. |
Pool Wait Time | The max seconds to wait for an available connection. |
Proxy Auth Scheme | The authentication type to use to authenticate to the ProxyServer proxy. |
Proxy Auto Detect | 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. |
Proxy Exceptions | A semicolon separated list of hosts or IPs that are exempt from connecting through the ProxyServer . |
Proxy Password | A password to be used to authenticate to the ProxyServer proxy. |
Proxy Port | The TCP port the ProxyServer proxy is running on. |
Proxy Server | The hostname or IP address of a proxy to route HTTP traffic through. |
Proxy SSL Type | The SSL type to use when connecting to the ProxyServer proxy. |
Proxy User | A user name to be used to authenticate to the ProxyServer proxy. |
Pseudo Columns | 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. |
Region | The hosting region for your Amazon Web Services. |
Retry Wait Time | The minimum number of milliseconds the provider will wait to retry a request. |
Role ARN | The optional Amazon Resource Name of the role to use when authenticating. |
Row Scan Depth | The maximum number of rows to scan to look for the columns available in a table. |
RTK | The runtime key used for licensing. |
Secret Key | Your AWS account secret key. This value is accessible from your AWS security credentials page. |
Separator Character | The character or characters used to denote hierarchy. |
SSL Server Cert | The certificate to be accepted from the server when connecting using TLS/SSL. |
Support Enhanced SQL | This property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
Temporary Token Duration | The amount of time (in seconds) a temporary token will last. |
Thread Count | 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. |
Type Detection Scheme | Determines how to determine the data type of columns. |
URL | The URL to use when submitting requests. This should not normally need to be set. |
Use Connection Pooling | This property enables connection pooling. |
Use EC2 Roles | A boolean indicating if you would like to use EC2 credentials. |
Use Simple Names | Boolean determining if simple names should be used for tables and columns. |
Verbosity | The verbosity level that determines the amount of detail included in the log file. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |