Arctic URI¶
The URI provided to an Arctic instance is used to specify the storage backend and its configuration.
S3¶
The S3 URI connection scheme has the form s3(s)://<s3 end point>:<s3 bucket>[?options].
Use s3s as the protocol if communicating with a secure endpoint.
Options is a query string that specifies connection specific options as <name>=<value> pairs joined with
&.
Available options for S3:
| Option | Description |
|---|---|
| port | port to use for S3 connection |
| region | S3 region |
| use_virtual_addressing | Whether to use virtual addressing to access the S3 bucket |
| access | S3 access key |
| secret | S3 secret access key |
| path_prefix | Path within S3 bucket to use for data storage |
| aws_auth | AWS authentication method. If setting is default (or true for backward compatibility), authentication to endpoint will be computed via AWS default credential provider chain. If setting is sts, AWS Security Token Service (STS) will be the authentication method used. If no options are provided AWS authentication will not be used and you should specify access and secret in the URI. More info is provided below |
| aws_profile | Only when aws_auth is set to be sts. AWS profile to be used with AWS Security Token Service (STS). More info is provided below |
Note: When connecting to AWS, region can be automatically deduced from the endpoint if the given endpoint
specifies the region and region is not set.
Azure¶
The Azure URI connection scheme has the form azure://[options].
It is based on the Azure Connection String, with additional options for configuring ArcticDB.
Please refer to Azure for more details.
options is a string that specifies connection specific options as <name>=<value> pairs joined with ; (the final key value pair should not include a trailing ;).
Additional options specific for ArcticDB:
| Option | Description |
|---|---|
| Container | Azure container for blobs |
| Path_prefix | Path within Azure container to use for data storage |
| CA_cert_path | (Linux platform only) Azure CA certificate path. If not set, python ssl.get_default_verify_paths().cafile will be used. If the certificate cannot be found in the provided path, an Azure exception with no meaningful error code will be thrown. For more details, please see here. For example, Failed to iterate azure blobs 'C' 0:. |
| CA_cert_dir | (Linux platform only) Azure CA certificate directory. If not set, python ssl.get_default_verify_paths().capath will be used. Certificates can only be used if corresponding hash files exist. If the certificate cannot be found in the provided path, an Azure exception with no meaningful error code will be thrown. For more details, please see here. For example, Failed to iterate azure blobs 'C' 0:. |
For non-Linux platforms, neither CA_cert_path nor CA_cert_dir may be set. Please set CA certificate related options using operating system settings.
For Windows, please see here
Exception: Azure exceptions message always ends with {AZURE_SDK_HTTP_STATUS_CODE}:{AZURE_SDK_REASON_PHRASE}.
Please refer to azure-sdk-for-cpp for more details of provided status codes.
Note that due to a bug in Azure C++ SDK, Azure may not give meaningful status codes and
reason phrases in the exception. To debug these instances, please set the environment variable export AZURE_LOG_LEVEL to 1 to turn on the SDK debug logging.
LMDB¶
The LMDB connection scheme has the form lmdb:///<path to store LMDB files>[?options].
Options is a query string that specifies connection specific options as <name>=<value> pairs joined with
&.
| Option | Description |
|---|---|
| map_size | LMDB map size (see here). String. Supported formats are: "150MB" / "20GB" / "3TB" The only supported units are MB / GB / TB. On Windows and MacOS, LMDB will materialize a file of this size, so you need to set it to a reasonable value that your system has room for, and it has a small default (order of 1GB). On Linux, this is an upper bound on the space used by LMDB and the default is large (order of 100GB). ArcticDB creates an LMDB database per library, so the map_size will be per library. |
Example connection strings are lmdb:///home/user/my_lmdb or lmdb:///home/user/my_lmdb?map_size=2GB.
In-Memory¶
The in-memory connection scheme has the form mem://.
The storage is local to the Arctic instance.