Vortex arrays support reading and writing to many object storage systems:
- vortex.store.from_url(url: str, *, config: S3Config | None = None, client_options: ClientConfig | None = None, retry_config: RetryConfig | None = None, credential_provider: S3CredentialProvider | None = None, **kwargs: Unpack[S3Config]) → AzureStore | GCSStore | HTTPStore | S3Store | LocalStore | MemoryStore#
- vortex.store.from_url(url: str, *, config: GCSConfig | None = None, client_options: ClientConfig | None = None, retry_config: RetryConfig | None = None, credential_provider: GCSCredentialProvider | None = None, **kwargs: Unpack[GCSConfig]) → AzureStore | GCSStore | HTTPStore | S3Store | LocalStore | MemoryStore
- vortex.store.from_url(url: str, *, config: AzureConfig | None = None, client_options: ClientConfig | None = None, retry_config: RetryConfig | None = None, credential_provider: AzureCredentialProvider | None = None, **kwargs: Unpack[AzureConfig]) → AzureStore | GCSStore | HTTPStore | S3Store | LocalStore | MemoryStore
- vortex.store.from_url(url: str, *, config: None = None, client_options: None = None, retry_config: None = None, automatic_cleanup: bool = False, mkdir: bool = False) → AzureStore | GCSStore | HTTPStore | S3Store | LocalStore | MemoryStore
Easy construction of store by URL, identifying the relevant store.
This will defer to a store-specific
from_urlconstructor based on the providedurl. E.g. passing"s3://bucket/path"will defer toS3Store.from_url.Supported formats:
file:///path/to/my/file->LocalStorememory:///->MemoryStores3://bucket/path->S3Store(also supportss3a)gs://bucket/path->GCSStoreaz://account/container/path->AzureStore(also supportsadl,azure,abfs,abfss)http://mydomain/path->HTTPStorehttps://mydomain/path->HTTPStore
There are also special cases for AWS and Azure for
https://{host?}/pathpaths:dfs.core.windows.net,blob.core.windows.net,dfs.fabric.microsoft.com,blob.fabric.microsoft.com->AzureStoreamazonaws.com->S3Storer2.cloudflarestorage.com->S3Store
Note
For best static typing, use the constructors on individual store classes directly.
- Parameters:
url – well-known storage URL.
- Keyword Arguments:
config – per-store Configuration. Values in this config will override values inferred from the url. Defaults to None.
client_options – HTTP Client options. Defaults to None.
retry_config – Retry configuration. Defaults to None.
credential_provider – A callback to provide custom credentials to the underlying store classes.
kwargs – per-store configuration passed down to store-specific builders.