This is page 54 of 55. Use http://codebase.md/apache/opendal?page={x} to view the full context.
# Directory Structure
```
├── .asf.yaml
├── .config
│ └── nextest.toml
├── .devcontainer
│ ├── devcontainer.json
│ └── post_create.sh
├── .editorconfig
├── .env.example
├── .gitattributes
├── .github
│ ├── actions
│ │ ├── fuzz_test
│ │ │ └── action.yaml
│ │ ├── setup
│ │ │ └── action.yaml
│ │ ├── setup-hadoop
│ │ │ └── action.yaml
│ │ ├── setup-ocaml
│ │ │ └── action.yaml
│ │ ├── test_behavior_binding_c
│ │ │ └── action.yaml
│ │ ├── test_behavior_binding_cpp
│ │ │ └── action.yaml
│ │ ├── test_behavior_binding_go
│ │ │ └── action.yaml
│ │ ├── test_behavior_binding_java
│ │ │ └── action.yaml
│ │ ├── test_behavior_binding_nodejs
│ │ │ └── action.yaml
│ │ ├── test_behavior_binding_python
│ │ │ └── action.yaml
│ │ ├── test_behavior_core
│ │ │ └── action.yaml
│ │ └── test_behavior_integration_object_store
│ │ └── action.yml
│ ├── CODEOWNERS
│ ├── dependabot.yml
│ ├── ISSUE_TEMPLATE
│ │ ├── 1-bug-report.yml
│ │ ├── 2-feature-request.yml
│ │ ├── 3-new-release.md
│ │ └── config.yml
│ ├── pull_request_template.md
│ ├── release.yml
│ ├── scripts
│ │ ├── test_behavior
│ │ │ ├── __init__.py
│ │ │ ├── plan.py
│ │ │ └── test_plan.py
│ │ ├── test_go_binding
│ │ │ ├── generate_test_scheme.py
│ │ │ └── matrix.yaml
│ │ └── weekly_update
│ │ ├── .gitignore
│ │ ├── .python-version
│ │ ├── main.py
│ │ ├── pyproject.toml
│ │ ├── README.md
│ │ └── uv.lock
│ ├── services
│ │ ├── aliyun_drive
│ │ │ └── aliyun_drive
│ │ │ └── disable_action.yml
│ │ ├── alluxio
│ │ │ └── alluxio
│ │ │ └── action.yml
│ │ ├── azblob
│ │ │ ├── azure_azblob
│ │ │ │ └── action.yml
│ │ │ └── azurite_azblob
│ │ │ └── action.yml
│ │ ├── azdls
│ │ │ └── azdls
│ │ │ └── action.yml
│ │ ├── azfile
│ │ │ └── azfile
│ │ │ └── action.yml
│ │ ├── b2
│ │ │ └── b2
│ │ │ └── action.yml
│ │ ├── cacache
│ │ │ └── cacache
│ │ │ └── action.yml
│ │ ├── compfs
│ │ │ └── compfs
│ │ │ └── action.yml
│ │ ├── cos
│ │ │ └── cos
│ │ │ └── action.yml
│ │ ├── dashmap
│ │ │ └── dashmap
│ │ │ └── action.yml
│ │ ├── dropbox
│ │ │ └── dropbox
│ │ │ └── disable_action.yml
│ │ ├── etcd
│ │ │ ├── etcd
│ │ │ │ └── action.yml
│ │ │ ├── etcd-cluster
│ │ │ │ └── action.yml
│ │ │ └── etcd-tls
│ │ │ └── action.yml
│ │ ├── fs
│ │ │ └── local_fs
│ │ │ └── action.yml
│ │ ├── ftp
│ │ │ └── vsftpd
│ │ │ └── disable_action.yml
│ │ ├── gcs
│ │ │ ├── gcs
│ │ │ │ └── action.yml
│ │ │ └── gcs_with_default_storage_class
│ │ │ └── action.yml
│ │ ├── gdrive
│ │ │ └── gdrive
│ │ │ └── action.yml
│ │ ├── gridfs
│ │ │ ├── gridfs
│ │ │ │ └── action.yml
│ │ │ └── gridfs_with_basic_auth
│ │ │ └── action.yml
│ │ ├── hdfs
│ │ │ ├── hdfs_cluster
│ │ │ │ └── action.yml
│ │ │ ├── hdfs_cluster_with_atomic_write_dir
│ │ │ │ └── action.yml
│ │ │ ├── hdfs_default
│ │ │ │ └── action.yml
│ │ │ ├── hdfs_default_gcs
│ │ │ │ └── action.yml
│ │ │ ├── hdfs_default_on_azurite_azblob
│ │ │ │ └── action.yml
│ │ │ ├── hdfs_default_on_minio_s3
│ │ │ │ └── action.yml
│ │ │ └── hdfs_default_with_atomic_write_dir
│ │ │ └── action.yml
│ │ ├── hdfs_native
│ │ │ └── hdfs_native_cluster
│ │ │ └── action.yml
│ │ ├── http
│ │ │ ├── caddy
│ │ │ │ └── action.yml
│ │ │ └── nginx
│ │ │ └── action.yml
│ │ ├── huggingface
│ │ │ └── huggingface
│ │ │ └── action.yml
│ │ ├── koofr
│ │ │ └── koofr
│ │ │ └── disable_action.yml
│ │ ├── memcached
│ │ │ ├── memcached
│ │ │ │ └── action.yml
│ │ │ └── memcached_with_auth
│ │ │ └── action.yml
│ │ ├── memory
│ │ │ └── memory
│ │ │ └── action.yml
│ │ ├── mini_moka
│ │ │ └── mini_moka
│ │ │ └── action.yml
│ │ ├── moka
│ │ │ └── moka
│ │ │ └── action.yml
│ │ ├── mongodb
│ │ │ ├── mongodb_with_basic_auth
│ │ │ │ └── action.yml
│ │ │ └── mongodb_with_no_auth
│ │ │ └── action.yml
│ │ ├── monoiofs
│ │ │ └── monoiofs
│ │ │ └── action.yml
│ │ ├── mysql
│ │ │ └── mysql
│ │ │ └── action.yml
│ │ ├── oss
│ │ │ ├── oss
│ │ │ │ └── action.yml
│ │ │ └── oss_with_versioning
│ │ │ └── action.yml
│ │ ├── persy
│ │ │ └── persy
│ │ │ └── action.yml
│ │ ├── postgresql
│ │ │ └── postgresql
│ │ │ └── action.yml
│ │ ├── redb
│ │ │ └── redb
│ │ │ └── action.yml
│ │ ├── redis
│ │ │ ├── dragonfly
│ │ │ │ └── action.yml
│ │ │ ├── kvrocks
│ │ │ │ └── action.yml
│ │ │ ├── redis
│ │ │ │ └── action.yml
│ │ │ ├── redis_tls
│ │ │ │ └── action.yml
│ │ │ ├── redis_with_cluster
│ │ │ │ └── action.yml
│ │ │ └── redis_with_cluster_tls
│ │ │ └── action.yml
│ │ ├── rocksdb
│ │ │ └── rocksdb
│ │ │ └── action.yml
│ │ ├── s3
│ │ │ ├── 0_minio_s3
│ │ │ │ └── action.yml
│ │ │ ├── aws_s3
│ │ │ │ └── action.yml
│ │ │ ├── aws_s3_with_list_objects_v1
│ │ │ │ └── action.yml
│ │ │ ├── aws_s3_with_sse_c
│ │ │ │ └── action.yml
│ │ │ ├── aws_s3_with_versioning
│ │ │ │ └── action.yml
│ │ │ ├── aws_s3_with_virtual_host
│ │ │ │ └── action.yml
│ │ │ ├── ceph_radios_s3_with_versioning
│ │ │ │ └── disable_action.yml
│ │ │ ├── ceph_rados_s3
│ │ │ │ └── disable_action.yml
│ │ │ ├── minio_s3_with_anonymous
│ │ │ │ └── action.yml
│ │ │ ├── minio_s3_with_list_objects_v1
│ │ │ │ └── action.yml
│ │ │ ├── minio_s3_with_versioning
│ │ │ │ └── action.yml
│ │ │ └── r2
│ │ │ └── disabled_action.yml
│ │ ├── seafile
│ │ │ └── seafile
│ │ │ └── action.yml
│ │ ├── sftp
│ │ │ ├── sftp
│ │ │ │ └── action.yml
│ │ │ └── sftp_with_default_root
│ │ │ └── action.yml
│ │ ├── sled
│ │ │ ├── sled
│ │ │ │ └── action.yml
│ │ │ └── sled_with_tree
│ │ │ └── action.yml
│ │ ├── sqlite
│ │ │ └── sqlite
│ │ │ └── action.yml
│ │ ├── swift
│ │ │ ├── ceph_rados_swift
│ │ │ │ └── action.yml
│ │ │ └── swift
│ │ │ └── action.yml
│ │ ├── tikv
│ │ │ └── tikv
│ │ │ └── disable_action.yml
│ │ ├── webdav
│ │ │ ├── 0_nginx
│ │ │ │ └── action.yml
│ │ │ ├── jfrog
│ │ │ │ └── disabled_action.yml
│ │ │ ├── nextcloud
│ │ │ │ └── action.yml
│ │ │ ├── nginx_with_empty_password
│ │ │ │ └── action.yml
│ │ │ ├── nginx_with_password
│ │ │ │ └── action.yml
│ │ │ ├── nginx_with_redirect
│ │ │ │ └── action.yml
│ │ │ └── owncloud
│ │ │ └── action.yml
│ │ └── webhdfs
│ │ ├── webhdfs
│ │ │ └── action.yml
│ │ ├── webhdfs_with_list_batch_disabled
│ │ │ └── action.yml
│ │ └── webhdfs_with_user_name
│ │ └── action.yml
│ └── workflows
│ ├── ci_bindings_c.yml
│ ├── ci_bindings_cpp.yml
│ ├── ci_bindings_d.yml
│ ├── ci_bindings_dart.yml
│ ├── ci_bindings_dotnet.yml
│ ├── ci_bindings_go.yml
│ ├── ci_bindings_haskell.yml
│ ├── ci_bindings_java.yml
│ ├── ci_bindings_lua.yml
│ ├── ci_bindings_nodejs.yml
│ ├── ci_bindings_ocaml.yml
│ ├── ci_bindings_php.yml
│ ├── ci_bindings_python.yml
│ ├── ci_bindings_ruby.yml
│ ├── ci_bindings_swift.yml
│ ├── ci_bindings_zig.yml
│ ├── ci_check.yml
│ ├── ci_core.yml
│ ├── ci_integration_dav_server.yml
│ ├── ci_integration_object_store.yml
│ ├── ci_integration_parquet.yml
│ ├── ci_integration_spring.yml
│ ├── ci_integration_unftp_sbe.yml
│ ├── ci_odev.yml
│ ├── ci_weekly_update.yml
│ ├── discussion-thread-link.yml
│ ├── docs.yml
│ ├── full-ci-promote.yml
│ ├── release_dart.yml
│ ├── release_java.yml
│ ├── release_nodejs.yml
│ ├── release_python.yml
│ ├── release_ruby.yml
│ ├── release_rust.yml
│ ├── service_test_ghac.yml
│ ├── test_behavior_binding_c.yml
│ ├── test_behavior_binding_cpp.yml
│ ├── test_behavior_binding_go.yml
│ ├── test_behavior_binding_java.yml
│ ├── test_behavior_binding_nodejs.yml
│ ├── test_behavior_binding_python.yml
│ ├── test_behavior_core.yml
│ ├── test_behavior_integration_object_store.yml
│ ├── test_behavior.yml
│ ├── test_edge.yml
│ └── test_fuzz.yml
├── .gitignore
├── .taplo.toml
├── .typos.toml
├── .vscode
│ └── settings.json
├── .yamlfmt
├── AGENTS.md
├── bindings
│ ├── java
│ │ ├── .cargo
│ │ │ └── config.toml
│ │ ├── .gitignore
│ │ ├── .mvn
│ │ │ └── wrapper
│ │ │ └── maven-wrapper.properties
│ │ ├── Cargo.toml
│ │ ├── DEPENDENCIES.md
│ │ ├── DEPENDENCIES.rust.tsv
│ │ ├── mvnw
│ │ ├── mvnw.cmd
│ │ ├── pom.xml
│ │ ├── README.md
│ │ ├── src
│ │ │ ├── async_operator.rs
│ │ │ ├── convert.rs
│ │ │ ├── error.rs
│ │ │ ├── executor.rs
│ │ │ ├── layer.rs
│ │ │ ├── lib.rs
│ │ │ ├── main
│ │ │ │ ├── java
│ │ │ │ │ └── org
│ │ │ │ │ └── apache
│ │ │ │ │ └── opendal
│ │ │ │ │ ├── AsyncExecutor.java
│ │ │ │ │ ├── AsyncOperator.java
│ │ │ │ │ ├── Capability.java
│ │ │ │ │ ├── Entry.java
│ │ │ │ │ ├── Environment.java
│ │ │ │ │ ├── layer
│ │ │ │ │ │ ├── ConcurrentLimitLayer.java
│ │ │ │ │ │ ├── package-info.java
│ │ │ │ │ │ └── RetryLayer.java
│ │ │ │ │ ├── Layer.java
│ │ │ │ │ ├── ListOptions.java
│ │ │ │ │ ├── Metadata.java
│ │ │ │ │ ├── NativeLibrary.java
│ │ │ │ │ ├── NativeObject.java
│ │ │ │ │ ├── OpenDAL.java
│ │ │ │ │ ├── OpenDALException.java
│ │ │ │ │ ├── Operator.java
│ │ │ │ │ ├── OperatorInfo.java
│ │ │ │ │ ├── OperatorInputStream.java
│ │ │ │ │ ├── OperatorOutputStream.java
│ │ │ │ │ ├── package-info.java
│ │ │ │ │ ├── PresignedRequest.java
│ │ │ │ │ ├── ReadOptions.java
│ │ │ │ │ ├── ServiceConfig.java
│ │ │ │ │ ├── StatOptions.java
│ │ │ │ │ └── WriteOptions.java
│ │ │ │ └── resources
│ │ │ │ ├── bindings.properties
│ │ │ │ └── META-INF
│ │ │ │ └── NOTICE
│ │ │ ├── operator_input_stream.rs
│ │ │ ├── operator_output_stream.rs
│ │ │ ├── operator.rs
│ │ │ ├── test
│ │ │ │ └── java
│ │ │ │ └── org
│ │ │ │ └── apache
│ │ │ │ └── opendal
│ │ │ │ └── test
│ │ │ │ ├── AsyncExecutorTest.java
│ │ │ │ ├── behavior
│ │ │ │ │ ├── AsyncCopyTest.java
│ │ │ │ │ ├── AsyncCreateDirTest.java
│ │ │ │ │ ├── AsyncListTest.java
│ │ │ │ │ ├── AsyncPresignTest.java
│ │ │ │ │ ├── AsyncReadOnlyTest.java
│ │ │ │ │ ├── AsyncRenameTest.java
│ │ │ │ │ ├── AsyncStatOptionsTest.java
│ │ │ │ │ ├── AsyncWriteOptionsTest.java
│ │ │ │ │ ├── AsyncWriteTest.java
│ │ │ │ │ ├── BehaviorExtension.java
│ │ │ │ │ ├── BehaviorTestBase.java
│ │ │ │ │ ├── BlockingCopyTest.java
│ │ │ │ │ ├── BlockingCreateDirTest.java
│ │ │ │ │ ├── BlockingListTest.java
│ │ │ │ │ ├── BlockingReadOnlyTest.java
│ │ │ │ │ ├── BlockingRenameTest.java
│ │ │ │ │ ├── BlockingStatOptionsTest.java
│ │ │ │ │ ├── BlockingWriteOptionTest.java
│ │ │ │ │ ├── BlockingWriteTest.java
│ │ │ │ │ └── RegressionTest.java
│ │ │ │ ├── condition
│ │ │ │ │ └── OpenDALExceptionCondition.java
│ │ │ │ ├── LayerTest.java
│ │ │ │ ├── MetadataTest.java
│ │ │ │ ├── OperatorDuplicateTest.java
│ │ │ │ ├── OperatorInfoTest.java
│ │ │ │ ├── OperatorInputOutputStreamTest.java
│ │ │ │ ├── OperatorUtf8DecodeTest.java
│ │ │ │ └── UtilityTest.java
│ │ │ └── utility.rs
│ │ ├── tools
│ │ │ └── build.py
│ │ ├── upgrade.md
│ │ └── users.md
│ ├── nodejs
│ │ ├── .cargo
│ │ │ └── config.toml
│ │ ├── .gitignore
│ │ ├── .node-version
│ │ ├── .npmignore
│ │ ├── .npmrc
│ │ ├── .prettierignore
│ │ ├── benchmark
│ │ │ ├── deno.ts
│ │ │ ├── node.js
│ │ │ └── README.md
│ │ ├── build.rs
│ │ ├── Cargo.toml
│ │ ├── CONTRIBUTING.md
│ │ ├── DEPENDENCIES.md
│ │ ├── DEPENDENCIES.rust.tsv
│ │ ├── devbox.json
│ │ ├── devbox.lock
│ │ ├── generated.d.ts
│ │ ├── generated.js
│ │ ├── index.cjs
│ │ ├── index.d.ts
│ │ ├── index.mjs
│ │ ├── npm
│ │ │ ├── darwin-arm64
│ │ │ │ ├── package.json
│ │ │ │ └── README.md
│ │ │ ├── darwin-x64
│ │ │ │ ├── package.json
│ │ │ │ └── README.md
│ │ │ ├── linux-arm64-gnu
│ │ │ │ ├── package.json
│ │ │ │ └── README.md
│ │ │ ├── linux-arm64-musl
│ │ │ │ ├── package.json
│ │ │ │ └── README.md
│ │ │ ├── linux-x64-gnu
│ │ │ │ ├── package.json
│ │ │ │ └── README.md
│ │ │ ├── linux-x64-musl
│ │ │ │ ├── package.json
│ │ │ │ └── README.md
│ │ │ ├── win32-arm64-msvc
│ │ │ │ ├── package.json
│ │ │ │ └── README.md
│ │ │ └── win32-x64-msvc
│ │ │ ├── package.json
│ │ │ └── README.md
│ │ ├── package.json
│ │ ├── pnpm-lock.yaml
│ │ ├── README.md
│ │ ├── scripts
│ │ │ └── header.mjs
│ │ ├── src
│ │ │ ├── capability.rs
│ │ │ ├── layer.rs
│ │ │ ├── lib.rs
│ │ │ └── options.rs
│ │ ├── tests
│ │ │ ├── service.test.mjs
│ │ │ ├── suites
│ │ │ │ ├── async.suite.mjs
│ │ │ │ ├── asyncDeleteOptions.suite.mjs
│ │ │ │ ├── asyncLister.suite.mjs
│ │ │ │ ├── asyncListOptions.suite.mjs
│ │ │ │ ├── asyncReadOptions.suite.mjs
│ │ │ │ ├── asyncStatOptions.suite.mjs
│ │ │ │ ├── asyncWriteOptions.suite.mjs
│ │ │ │ ├── index.mjs
│ │ │ │ ├── layer.suite.mjs
│ │ │ │ ├── services.suite.mjs
│ │ │ │ ├── sync.suite.mjs
│ │ │ │ ├── syncDeleteOptions.suite.mjs
│ │ │ │ ├── syncLister.suite.mjs
│ │ │ │ ├── syncListOptions.suite.mjs
│ │ │ │ ├── syncReadOptions.suite.mjs
│ │ │ │ ├── syncStatOptions.suite.mjs
│ │ │ │ └── syncWriteOptions.suite.mjs
│ │ │ └── utils.mjs
│ │ ├── theme
│ │ │ ├── index.tsx
│ │ │ └── package.json
│ │ ├── tsconfig.json
│ │ ├── tsconfig.theme.json
│ │ ├── typedoc.json
│ │ ├── upgrade.md
│ │ └── vitest.config.mjs
│ ├── python
│ │ ├── .gitignore
│ │ ├── benchmark
│ │ │ ├── async_opendal_benchmark.py
│ │ │ ├── async_origin_s3_benchmark_with_gevent.py
│ │ │ └── README.md
│ │ ├── Cargo.toml
│ │ ├── CONTRIBUTING.md
│ │ ├── DEPENDENCIES.md
│ │ ├── DEPENDENCIES.rust.tsv
│ │ ├── docs
│ │ │ ├── api
│ │ │ │ ├── async_file.md
│ │ │ │ ├── async_operator.md
│ │ │ │ ├── capability.md
│ │ │ │ ├── exceptions.md
│ │ │ │ ├── file.md
│ │ │ │ ├── layers.md
│ │ │ │ ├── operator.md
│ │ │ │ └── types.md
│ │ │ └── index.md
│ │ ├── justfile
│ │ ├── mkdocs.yml
│ │ ├── pyproject.toml
│ │ ├── pyrightconfig.json
│ │ ├── python
│ │ │ └── opendal
│ │ │ ├── __init__.py
│ │ │ ├── capability.pyi
│ │ │ ├── exceptions.pyi
│ │ │ ├── file.pyi
│ │ │ ├── layers.pyi
│ │ │ ├── operator.pyi
│ │ │ ├── py.typed
│ │ │ ├── services.pyi
│ │ │ └── types.pyi
│ │ ├── README.md
│ │ ├── ruff.toml
│ │ ├── src
│ │ │ ├── capability.rs
│ │ │ ├── errors.rs
│ │ │ ├── file.rs
│ │ │ ├── layers.rs
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ ├── metadata.rs
│ │ │ ├── operator.rs
│ │ │ ├── options.rs
│ │ │ ├── services.rs
│ │ │ └── utils.rs
│ │ ├── template
│ │ │ └── module.html.jinja2
│ │ ├── tests
│ │ │ ├── conftest.py
│ │ │ ├── test_async_check.py
│ │ │ ├── test_async_copy.py
│ │ │ ├── test_async_delete.py
│ │ │ ├── test_async_exists.py
│ │ │ ├── test_async_list.py
│ │ │ ├── test_async_pickle_types.py
│ │ │ ├── test_async_rename.py
│ │ │ ├── test_capability.py
│ │ │ ├── test_exceptions.py
│ │ │ ├── test_pickle_rw.py
│ │ │ ├── test_read.py
│ │ │ ├── test_sync_check.py
│ │ │ ├── test_sync_copy.py
│ │ │ ├── test_sync_delete.py
│ │ │ ├── test_sync_exists.py
│ │ │ ├── test_sync_list.py
│ │ │ ├── test_sync_pickle_types.py
│ │ │ ├── test_sync_rename.py
│ │ │ └── test_write.py
│ │ ├── upgrade.md
│ │ ├── users.md
│ │ └── uv.lock
│ └── README.md
├── CHANGELOG.md
├── CITATION.cff
├── CLAUDE.md
├── CONTRIBUTING.md
├── core
│ ├── benches
│ │ ├── ops
│ │ │ ├── main.rs
│ │ │ ├── read.rs
│ │ │ ├── README.md
│ │ │ ├── utils.rs
│ │ │ └── write.rs
│ │ ├── README.md
│ │ ├── types
│ │ │ ├── buffer.rs
│ │ │ ├── main.rs
│ │ │ ├── README.md
│ │ │ └── tasks.rs
│ │ ├── vs_fs
│ │ │ ├── Cargo.toml
│ │ │ ├── README.md
│ │ │ └── src
│ │ │ └── main.rs
│ │ └── vs_s3
│ │ ├── Cargo.toml
│ │ ├── README.md
│ │ └── src
│ │ └── main.rs
│ ├── Cargo.lock
│ ├── Cargo.toml
│ ├── CHANGELOG.md
│ ├── CONTRIBUTING.md
│ ├── core
│ │ ├── Cargo.toml
│ │ └── src
│ │ ├── blocking
│ │ │ ├── delete.rs
│ │ │ ├── list.rs
│ │ │ ├── mod.rs
│ │ │ ├── operator.rs
│ │ │ ├── read
│ │ │ │ ├── buffer_iterator.rs
│ │ │ │ ├── mod.rs
│ │ │ │ ├── reader.rs
│ │ │ │ ├── std_bytes_iterator.rs
│ │ │ │ └── std_reader.rs
│ │ │ └── write
│ │ │ ├── mod.rs
│ │ │ ├── std_writer.rs
│ │ │ └── writer.rs
│ │ ├── docs
│ │ │ ├── comparisons
│ │ │ │ ├── mod.rs
│ │ │ │ └── vs_object_store.md
│ │ │ ├── concepts.rs
│ │ │ ├── internals
│ │ │ │ ├── accessor.rs
│ │ │ │ ├── layer.rs
│ │ │ │ └── mod.rs
│ │ │ ├── mod.rs
│ │ │ ├── performance
│ │ │ │ ├── concurrent_write.md
│ │ │ │ ├── http_optimization.md
│ │ │ │ └── mod.rs
│ │ │ ├── rfcs
│ │ │ │ ├── 0000_example.md
│ │ │ │ ├── 0041_object_native_api.md
│ │ │ │ ├── 0044_error_handle.md
│ │ │ │ ├── 0057_auto_region.md
│ │ │ │ ├── 0069_object_stream.md
│ │ │ │ ├── 0090_limited_reader.md
│ │ │ │ ├── 0112_path_normalization.md
│ │ │ │ ├── 0191_async_streaming_io.md
│ │ │ │ ├── 0203_remove_credential.md
│ │ │ │ ├── 0221_create_dir.md
│ │ │ │ ├── 0247_retryable_error.md
│ │ │ │ ├── 0293_object_id.md
│ │ │ │ ├── 0337_dir_entry.md
│ │ │ │ ├── 0409_accessor_capabilities.md
│ │ │ │ ├── 0413_presign.md
│ │ │ │ ├── 0423_command_line_interface.md
│ │ │ │ ├── 0429_init_from_iter.md
│ │ │ │ ├── 0438_multipart.md
│ │ │ │ ├── 0443_gateway.md
│ │ │ │ ├── 0501_new_builder.md
│ │ │ │ ├── 0554_write_refactor.md
│ │ │ │ ├── 0561_list_metadata_reuse.md
│ │ │ │ ├── 0599_blocking_api.md
│ │ │ │ ├── 0623_redis_service.md
│ │ │ │ ├── 0627_split_capabilities.md
│ │ │ │ ├── 0661_path_in_accessor.md
│ │ │ │ ├── 0793_generic_kv_services.md
│ │ │ │ ├── 0926_object_reader.md
│ │ │ │ ├── 0977_refactor_error.md
│ │ │ │ ├── 1085_object_handler.md
│ │ │ │ ├── 1391_object_metadataer.md
│ │ │ │ ├── 1398_query_based_metadata.md
│ │ │ │ ├── 1420_object_writer.md
│ │ │ │ ├── 1477_remove_object_concept.md
│ │ │ │ ├── 1735_operation_extension.md
│ │ │ │ ├── 2083_writer_sink_api.md
│ │ │ │ ├── 2133_append_api.md
│ │ │ │ ├── 2299_chain_based_operator_api.md
│ │ │ │ ├── 2602_object_versioning.md
│ │ │ │ ├── 2758_merge_append_into_write.md
│ │ │ │ ├── 2774_lister_api.md
│ │ │ │ ├── 2779_list_with_metakey.md
│ │ │ │ ├── 2852_native_capability.md
│ │ │ │ ├── 2884_merge_range_read_into_read.md
│ │ │ │ ├── 3017_remove_write_copy_from.md
│ │ │ │ ├── 3197_config.md
│ │ │ │ ├── 3232_align_list_api.md
│ │ │ │ ├── 3243_list_prefix.md
│ │ │ │ ├── 3356_lazy_reader.md
│ │ │ │ ├── 3526_list_recursive.md
│ │ │ │ ├── 3574_concurrent_stat_in_list.md
│ │ │ │ ├── 3734_buffered_reader.md
│ │ │ │ ├── 3898_concurrent_writer.md
│ │ │ │ ├── 3911_deleter_api.md
│ │ │ │ ├── 4382_range_based_read.md
│ │ │ │ ├── 4638_executor.md
│ │ │ │ ├── 5314_remove_metakey.md
│ │ │ │ ├── 5444_operator_from_uri.md
│ │ │ │ ├── 5479_context.md
│ │ │ │ ├── 5485_conditional_reader.md
│ │ │ │ ├── 5495_list_with_deleted.md
│ │ │ │ ├── 5556_write_returns_metadata.md
│ │ │ │ ├── 5871_read_returns_metadata.md
│ │ │ │ ├── 6189_remove_native_blocking.md
│ │ │ │ ├── 6209_glob_support.md
│ │ │ │ ├── 6213_options_api.md
│ │ │ │ ├── 6370_foyer_integration.md
│ │ │ │ ├── 6678_simulate_layer.md
│ │ │ │ ├── 6707_capability_override_layer.md
│ │ │ │ ├── 6817_checksum.md
│ │ │ │ ├── 6828_core.md
│ │ │ │ ├── 7130_route_layer.md
│ │ │ │ ├── mod.rs
│ │ │ │ └── README.md
│ │ │ └── upgrade.md
│ │ ├── layers
│ │ │ ├── complete.rs
│ │ │ ├── correctness_check.rs
│ │ │ ├── error_context.rs
│ │ │ ├── http_client.rs
│ │ │ ├── mod.rs
│ │ │ ├── simulate.rs
│ │ │ └── type_eraser.rs
│ │ ├── lib.rs
│ │ ├── raw
│ │ │ ├── accessor.rs
│ │ │ ├── atomic_util.rs
│ │ │ ├── enum_utils.rs
│ │ │ ├── futures_util.rs
│ │ │ ├── http_util
│ │ │ │ ├── body.rs
│ │ │ │ ├── bytes_content_range.rs
│ │ │ │ ├── bytes_range.rs
│ │ │ │ ├── client.rs
│ │ │ │ ├── error.rs
│ │ │ │ ├── header.rs
│ │ │ │ ├── mod.rs
│ │ │ │ ├── multipart.rs
│ │ │ │ └── uri.rs
│ │ │ ├── layer.rs
│ │ │ ├── mod.rs
│ │ │ ├── oio
│ │ │ │ ├── buf
│ │ │ │ │ ├── flex_buf.rs
│ │ │ │ │ ├── mod.rs
│ │ │ │ │ ├── pooled_buf.rs
│ │ │ │ │ └── queue_buf.rs
│ │ │ │ ├── delete
│ │ │ │ │ ├── api.rs
│ │ │ │ │ ├── batch_delete.rs
│ │ │ │ │ ├── mod.rs
│ │ │ │ │ └── one_shot_delete.rs
│ │ │ │ ├── entry.rs
│ │ │ │ ├── list
│ │ │ │ │ ├── api.rs
│ │ │ │ │ ├── flat_list.rs
│ │ │ │ │ ├── hierarchy_list.rs
│ │ │ │ │ ├── mod.rs
│ │ │ │ │ ├── page_list.rs
│ │ │ │ │ └── prefix_list.rs
│ │ │ │ ├── mod.rs
│ │ │ │ ├── read
│ │ │ │ │ ├── api.rs
│ │ │ │ │ └── mod.rs
│ │ │ │ └── write
│ │ │ │ ├── api.rs
│ │ │ │ ├── append_write.rs
│ │ │ │ ├── block_write.rs
│ │ │ │ ├── mod.rs
│ │ │ │ ├── multipart_write.rs
│ │ │ │ ├── one_shot_write.rs
│ │ │ │ └── position_write.rs
│ │ │ ├── operation.rs
│ │ │ ├── ops.rs
│ │ │ ├── path_cache.rs
│ │ │ ├── path.rs
│ │ │ ├── rps.rs
│ │ │ ├── serde_util.rs
│ │ │ ├── std_io_util.rs
│ │ │ ├── time.rs
│ │ │ ├── tokio_util.rs
│ │ │ └── version.rs
│ │ ├── services
│ │ │ ├── memory
│ │ │ │ ├── backend.rs
│ │ │ │ ├── config.rs
│ │ │ │ ├── core.rs
│ │ │ │ ├── deleter.rs
│ │ │ │ ├── docs.md
│ │ │ │ ├── lister.rs
│ │ │ │ ├── mod.rs
│ │ │ │ └── writer.rs
│ │ │ └── mod.rs
│ │ └── types
│ │ ├── buffer.rs
│ │ ├── builder.rs
│ │ ├── capability.rs
│ │ ├── context
│ │ │ ├── mod.rs
│ │ │ ├── read.rs
│ │ │ └── write.rs
│ │ ├── delete
│ │ │ ├── deleter.rs
│ │ │ ├── futures_delete_sink.rs
│ │ │ ├── input.rs
│ │ │ └── mod.rs
│ │ ├── entry.rs
│ │ ├── error.rs
│ │ ├── execute
│ │ │ ├── api.rs
│ │ │ ├── executor.rs
│ │ │ ├── executors
│ │ │ │ ├── mod.rs
│ │ │ │ └── tokio_executor.rs
│ │ │ └── mod.rs
│ │ ├── list.rs
│ │ ├── metadata.rs
│ │ ├── mod.rs
│ │ ├── mode.rs
│ │ ├── operator
│ │ │ ├── builder.rs
│ │ │ ├── info.rs
│ │ │ ├── mod.rs
│ │ │ ├── operator_futures.rs
│ │ │ ├── operator.rs
│ │ │ ├── registry.rs
│ │ │ └── uri.rs
│ │ ├── options.rs
│ │ ├── read
│ │ │ ├── buffer_stream.rs
│ │ │ ├── futures_async_reader.rs
│ │ │ ├── futures_bytes_stream.rs
│ │ │ ├── mod.rs
│ │ │ └── reader.rs
│ │ └── write
│ │ ├── buffer_sink.rs
│ │ ├── futures_async_writer.rs
│ │ ├── futures_bytes_sink.rs
│ │ ├── mod.rs
│ │ └── writer.rs
│ ├── DEPENDENCIES.md
│ ├── DEPENDENCIES.rust.tsv
│ ├── edge
│ │ ├── file_write_on_full_disk
│ │ │ ├── Cargo.toml
│ │ │ ├── README.md
│ │ │ └── src
│ │ │ └── main.rs
│ │ ├── README.md
│ │ ├── s3_aws_assume_role_with_web_identity
│ │ │ ├── Cargo.toml
│ │ │ ├── README.md
│ │ │ └── src
│ │ │ └── main.rs
│ │ └── s3_read_on_wasm
│ │ ├── .gitignore
│ │ ├── Cargo.toml
│ │ ├── README.md
│ │ ├── src
│ │ │ └── lib.rs
│ │ └── webdriver.json
│ ├── fuzz
│ │ ├── .gitignore
│ │ ├── Cargo.toml
│ │ ├── fuzz_reader.rs
│ │ ├── fuzz_writer.rs
│ │ └── README.md
│ ├── layers
│ │ ├── async-backtrace
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ └── lib.rs
│ │ ├── await-tree
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ └── lib.rs
│ │ ├── capability-check
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ └── lib.rs
│ │ ├── chaos
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ └── lib.rs
│ │ ├── concurrent-limit
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ └── lib.rs
│ │ ├── dtrace
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ └── lib.rs
│ │ ├── fastmetrics
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ └── lib.rs
│ │ ├── fastrace
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ └── lib.rs
│ │ ├── foyer
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ └── lib.rs
│ │ ├── hotpath
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ └── lib.rs
│ │ ├── immutable-index
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ └── lib.rs
│ │ ├── logging
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ └── lib.rs
│ │ ├── metrics
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ └── lib.rs
│ │ ├── mime-guess
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ └── lib.rs
│ │ ├── observe-metrics-common
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ └── lib.rs
│ │ ├── otelmetrics
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ └── lib.rs
│ │ ├── oteltrace
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ └── lib.rs
│ │ ├── prometheus
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ └── lib.rs
│ │ ├── prometheus-client
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ └── lib.rs
│ │ ├── retry
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ └── lib.rs
│ │ ├── route
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ └── lib.rs
│ │ ├── tail-cut
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ └── lib.rs
│ │ ├── throttle
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ └── lib.rs
│ │ ├── timeout
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ └── lib.rs
│ │ └── tracing
│ │ ├── Cargo.toml
│ │ └── src
│ │ └── lib.rs
│ ├── LICENSE
│ ├── README.md
│ ├── services
│ │ ├── aliyun-drive
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── error.rs
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ └── writer.rs
│ │ ├── alluxio
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── error.rs
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ └── writer.rs
│ │ ├── azblob
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── error.rs
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ └── writer.rs
│ │ ├── azdls
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── error.rs
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ └── writer.rs
│ │ ├── azfile
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── error.rs
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ └── writer.rs
│ │ ├── azure-common
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ └── lib.rs
│ │ ├── b2
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── error.rs
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ └── writer.rs
│ │ ├── cacache
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── lib.rs
│ │ │ └── writer.rs
│ │ ├── cloudflare-kv
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── error.rs
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ ├── model.rs
│ │ │ └── writer.rs
│ │ ├── compfs
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ ├── reader.rs
│ │ │ └── writer.rs
│ │ ├── cos
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── error.rs
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ └── writer.rs
│ │ ├── d1
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── error.rs
│ │ │ ├── lib.rs
│ │ │ ├── model.rs
│ │ │ └── writer.rs
│ │ ├── dashmap
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ └── writer.rs
│ │ ├── dbfs
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── error.rs
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ └── writer.rs
│ │ ├── dropbox
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── builder.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── error.rs
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ └── writer.rs
│ │ ├── etcd
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── error.rs
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ └── writer.rs
│ │ ├── foundationdb
│ │ │ ├── build.rs
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── lib.rs
│ │ │ └── writer.rs
│ │ ├── fs
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── error.rs
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ ├── reader.rs
│ │ │ └── writer.rs
│ │ ├── ftp
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── err.rs
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ ├── reader.rs
│ │ │ └── writer.rs
│ │ ├── gcs
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── error.rs
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ ├── uri.rs
│ │ │ └── writer.rs
│ │ ├── gdrive
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── builder.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── error.rs
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ └── writer.rs
│ │ ├── ghac
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── docs.md
│ │ │ ├── error.rs
│ │ │ ├── lib.rs
│ │ │ └── writer.rs
│ │ ├── github
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── error.rs
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ ├── mod.rs
│ │ │ └── writer.rs
│ │ ├── gridfs
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── lib.rs
│ │ │ └── writer.rs
│ │ ├── hdfs
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ ├── reader.rs
│ │ │ └── writer.rs
│ │ ├── hdfs-native
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── error.rs
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ ├── reader.rs
│ │ │ └── writer.rs
│ │ ├── http
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── docs.md
│ │ │ ├── error.rs
│ │ │ └── lib.rs
│ │ ├── huggingface
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── docs.md
│ │ │ ├── error.rs
│ │ │ ├── lib.rs
│ │ │ └── lister.rs
│ │ ├── ipfs
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── docs.md
│ │ │ ├── error.rs
│ │ │ ├── ipld.rs
│ │ │ └── lib.rs
│ │ ├── ipmfs
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── builder.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── error.rs
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ └── writer.rs
│ │ ├── koofr
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── error.rs
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ └── writer.rs
│ │ ├── lakefs
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── error.rs
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ └── writer.rs
│ │ ├── memcached
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── binary.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── lib.rs
│ │ │ └── writer.rs
│ │ ├── mini_moka
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ └── writer.rs
│ │ ├── moka
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ └── writer.rs
│ │ ├── mongodb
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── lib.rs
│ │ │ └── writer.rs
│ │ ├── monoiofs
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── lib.rs
│ │ │ ├── reader.rs
│ │ │ └── writer.rs
│ │ ├── mysql
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── lib.rs
│ │ │ └── writer.rs
│ │ ├── obs
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── error.rs
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ └── writer.rs
│ │ ├── onedrive
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── builder.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── error.rs
│ │ │ ├── graph_model.rs
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ └── writer.rs
│ │ ├── opfs
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── docs.md
│ │ │ ├── error.rs
│ │ │ ├── lib.rs
│ │ │ └── utils.rs
│ │ ├── oss
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── error.rs
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ └── writer.rs
│ │ ├── pcloud
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── error.rs
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ └── writer.rs
│ │ ├── persy
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── lib.rs
│ │ │ └── writer.rs
│ │ ├── postgresql
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── lib.rs
│ │ │ └── writer.rs
│ │ ├── redb
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── lib.rs
│ │ │ └── writer.rs
│ │ ├── redis
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── delete.rs
│ │ │ ├── docs.md
│ │ │ ├── lib.rs
│ │ │ └── writer.rs
│ │ ├── rocksdb
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ └── writer.rs
│ │ ├── s3
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── compatible_services.md
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── error.rs
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ ├── mod.rs
│ │ │ └── writer.rs
│ │ ├── seafile
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── error.rs
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ └── writer.rs
│ │ ├── sftp
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── error.rs
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ ├── reader.rs
│ │ │ ├── utils.rs
│ │ │ └── writer.rs
│ │ ├── sled
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ └── writer.rs
│ │ ├── sqlite
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── lib.rs
│ │ │ └── writer.rs
│ │ ├── surrealdb
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── lib.rs
│ │ │ └── writer.rs
│ │ ├── swift
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── compatible_services.md
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── error.rs
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ └── writer.rs
│ │ ├── tikv
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── lib.rs
│ │ │ └── writer.rs
│ │ ├── upyun
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── error.rs
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ └── writer.rs
│ │ ├── vercel-artifacts
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── builder.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── docs.md
│ │ │ ├── error.rs
│ │ │ ├── lib.rs
│ │ │ └── writer.rs
│ │ ├── vercel-blob
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── error.rs
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ └── writer.rs
│ │ ├── webdav
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── error.rs
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ └── writer.rs
│ │ ├── webhdfs
│ │ │ ├── Cargo.toml
│ │ │ └── src
│ │ │ ├── backend.rs
│ │ │ ├── config.rs
│ │ │ ├── core.rs
│ │ │ ├── deleter.rs
│ │ │ ├── docs.md
│ │ │ ├── error.rs
│ │ │ ├── lib.rs
│ │ │ ├── lister.rs
│ │ │ ├── message.rs
│ │ │ └── writer.rs
│ │ └── yandex-disk
│ │ ├── Cargo.toml
│ │ └── src
│ │ ├── backend.rs
│ │ ├── config.rs
│ │ ├── core.rs
│ │ ├── deleter.rs
│ │ ├── docs.md
│ │ ├── error.rs
│ │ ├── lib.rs
│ │ ├── lister.rs
│ │ └── writer.rs
│ ├── src
│ │ └── lib.rs
│ ├── testkit
│ │ ├── Cargo.toml
│ │ └── src
│ │ ├── lib.rs
│ │ ├── read.rs
│ │ ├── utils.rs
│ │ └── write.rs
│ ├── tests
│ │ ├── behavior
│ │ │ ├── async_copy.rs
│ │ │ ├── async_create_dir.rs
│ │ │ ├── async_delete.rs
│ │ │ ├── async_list.rs
│ │ │ ├── async_presign.rs
│ │ │ ├── async_read.rs
│ │ │ ├── async_rename.rs
│ │ │ ├── async_stat.rs
│ │ │ ├── async_write.rs
│ │ │ ├── main.rs
│ │ │ ├── README.md
│ │ │ └── utils.rs
│ │ └── data
│ │ ├── normal_dir
│ │ │ └── .gitkeep
│ │ ├── normal_file.txt
│ │ ├── special_dir !@#$%^&()_+-=;',
│ │ │ └── .gitkeep
│ │ └── special_file !@#$%^&()_+-=;',.txt
│ ├── upgrade.md
│ └── users.md
├── deny.toml
├── DEPENDENCIES.md
├── dev
│ ├── Cargo.lock
│ ├── Cargo.toml
│ ├── README.md
│ └── src
│ ├── generate
│ │ ├── java.j2
│ │ ├── java.rs
│ │ ├── mod.rs
│ │ ├── parser.rs
│ │ ├── python.j2
│ │ └── python.rs
│ ├── main.rs
│ └── release
│ ├── mod.rs
│ └── package.rs
├── doap.rdf
├── fixtures
│ ├── alluxio
│ │ └── docker-compose-alluxio.yml
│ ├── azblob
│ │ └── docker-compose-azurite.yml
│ ├── data
│ │ ├── normal_dir
│ │ │ └── .gitkeep
│ │ ├── normal_file.txt
│ │ ├── special_dir !@#$%^&()_+-=;',
│ │ │ └── .gitkeep
│ │ └── special_file !@#$%^&()_+-=;',.txt
│ ├── etcd
│ │ ├── ca-key.pem
│ │ ├── ca.pem
│ │ ├── client-key.pem
│ │ ├── client.pem
│ │ ├── docker-compose-cluster.yml
│ │ ├── docker-compose-standalone-tls.yml
│ │ ├── docker-compose-standalone.yml
│ │ ├── server-key.pem
│ │ └── server.pem
│ ├── ftp
│ │ └── docker-compose-vsftpd.yml
│ ├── hdfs
│ │ ├── azurite-azblob-core-site.xml
│ │ ├── docker-compose-hdfs-cluster.yml
│ │ ├── gcs-core-site.xml
│ │ ├── hdfs-site.xml
│ │ └── minio-s3-core-site.xml
│ ├── http
│ │ ├── Caddyfile
│ │ ├── docker-compose-caddy.yml
│ │ ├── docker-compose-nginx.yml
│ │ └── nginx.conf
│ ├── libsql
│ │ ├── docker-compose-auth.yml
│ │ └── docker-compose.yml
│ ├── memcached
│ │ ├── docker-compose-memcached-with-auth.yml
│ │ └── docker-compose-memcached.yml
│ ├── mongodb
│ │ ├── docker-compose-basic-auth.yml
│ │ └── docker-compose-no-auth.yml
│ ├── mysql
│ │ ├── docker-compose.yml
│ │ └── init.sql
│ ├── postgresql
│ │ ├── docker-compose.yml
│ │ └── init.sql
│ ├── redis
│ │ ├── docker-compose-dragonfly.yml
│ │ ├── docker-compose-kvrocks.yml
│ │ ├── docker-compose-redis-cluster-tls.yml
│ │ ├── docker-compose-redis-cluster.yml
│ │ ├── docker-compose-redis-tls.yml
│ │ ├── docker-compose-redis.yml
│ │ └── ssl
│ │ ├── .gitignore
│ │ ├── ca.crt
│ │ ├── ca.key
│ │ ├── ca.srl
│ │ ├── README.md
│ │ ├── redis.crt
│ │ ├── redis.key
│ │ └── req.conf
│ ├── s3
│ │ ├── docker-compose-ceph-rados.yml
│ │ └── docker-compose-minio.yml
│ ├── seafile
│ │ └── docker-compose-seafile.yml
│ ├── sftp
│ │ ├── change_root_dir.sh
│ │ ├── docker-compose-sftp-with-default-root.yml
│ │ ├── docker-compose-sftp.yml
│ │ ├── health-check.sh
│ │ ├── test_ssh_key
│ │ └── test_ssh_key.pub
│ ├── sqlite
│ │ └── data.sql
│ ├── swift
│ │ ├── docker-compose-ceph-rados.yml
│ │ └── docker-compose-swift.yml
│ ├── tikv
│ │ ├── gen_cert.sh
│ │ ├── pd-tls.toml
│ │ ├── pd.toml
│ │ ├── ssl
│ │ │ ├── ca-key.pem
│ │ │ ├── ca.pem
│ │ │ ├── client-key.pem
│ │ │ ├── client.pem
│ │ │ ├── pd-server-key.pem
│ │ │ ├── pd-server.pem
│ │ │ ├── tikv-server-key.pem
│ │ │ └── tikv-server.pem
│ │ ├── tikv-tls.toml
│ │ └── tikv.toml
│ ├── webdav
│ │ ├── config
│ │ │ └── nginx
│ │ │ └── http.conf
│ │ ├── docker-compose-webdav-jfrog.yml
│ │ ├── docker-compose-webdav-nextcloud.yml
│ │ ├── docker-compose-webdav-owncloud.yml
│ │ ├── docker-compose-webdav-with-auth.yml
│ │ ├── docker-compose-webdav-with-empty-passwd.yml
│ │ ├── docker-compose-webdav.yml
│ │ └── health-check-nextcloud.sh
│ └── webhdfs
│ └── docker-compose-webhdfs.yml
├── justfile
├── LICENSE
├── licenserc.toml
├── NOTICE
├── README.md
├── rust-toolchain.toml
├── rustfmt.toml
└── scripts
├── constants.py
├── dependencies.py
├── merge_local_staging.py
├── README.md
├── verify.py
└── workspace.py
```
# Files
--------------------------------------------------------------------------------
/bindings/python/src/services.rs:
--------------------------------------------------------------------------------
```rust
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.
use crate::*;
use pyo3_stub_gen::{derive::*, inventory::submit, module_doc};
module_doc!(
"opendal.services",
r#"
Services.
>> DO NOT EDIT THIS FILE MANUALLY <<
This file is automatically generated by just recipe with name `stub-gen`
alongwith the rest of the stubs.
See justfile at path ``../../justfile`` for more details.
"#
);
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
class Operator:
@overload
def __new__(cls,
scheme: builtins.str,
/,
**kwargs: builtins.str,
) -> typing_extensions.Self: ...
"#
}
}
#[gen_stub_pyclass_enum]
#[pyclass(
eq,
eq_int,
dict,
hash,
frozen,
name = "Scheme",
module = "opendal.services"
)]
#[pyo3(rename_all = "PascalCase")]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum PyScheme {
#[cfg(feature = "services-aliyun-drive")]
AliyunDrive,
#[cfg(feature = "services-alluxio")]
Alluxio,
#[cfg(feature = "services-azblob")]
Azblob,
#[cfg(feature = "services-azdls")]
Azdls,
#[cfg(feature = "services-azfile")]
Azfile,
#[cfg(feature = "services-b2")]
B2,
#[cfg(feature = "services-cacache")]
Cacache,
#[cfg(feature = "services-cos")]
Cos,
#[cfg(feature = "services-dashmap")]
Dashmap,
#[cfg(feature = "services-dropbox")]
Dropbox,
#[cfg(feature = "services-fs")]
Fs,
#[cfg(feature = "services-ftp")]
Ftp,
#[cfg(feature = "services-gcs")]
Gcs,
#[cfg(feature = "services-gdrive")]
Gdrive,
#[cfg(feature = "services-ghac")]
Ghac,
#[cfg(feature = "services-gridfs")]
Gridfs,
#[cfg(feature = "services-hdfs-native")]
HdfsNative,
#[cfg(feature = "services-http")]
Http,
#[cfg(feature = "services-huggingface")]
Huggingface,
#[cfg(feature = "services-ipfs")]
Ipfs,
#[cfg(feature = "services-ipmfs")]
Ipmfs,
#[cfg(feature = "services-koofr")]
Koofr,
#[cfg(feature = "services-memcached")]
Memcached,
#[cfg(feature = "services-memory")]
Memory,
#[cfg(feature = "services-mini-moka")]
MiniMoka,
#[cfg(feature = "services-moka")]
Moka,
#[cfg(feature = "services-mongodb")]
Mongodb,
#[cfg(feature = "services-mysql")]
Mysql,
#[cfg(feature = "services-obs")]
Obs,
#[cfg(feature = "services-onedrive")]
Onedrive,
#[cfg(feature = "services-oss")]
Oss,
#[cfg(feature = "services-persy")]
Persy,
#[cfg(feature = "services-postgresql")]
Postgresql,
#[cfg(feature = "services-redb")]
Redb,
#[cfg(feature = "services-redis")]
Redis,
#[cfg(feature = "services-s3")]
S3,
#[cfg(feature = "services-seafile")]
Seafile,
#[cfg(feature = "services-sftp")]
Sftp,
#[cfg(feature = "services-sled")]
Sled,
#[cfg(feature = "services-sqlite")]
Sqlite,
#[cfg(feature = "services-swift")]
Swift,
#[cfg(feature = "services-upyun")]
Upyun,
#[cfg(feature = "services-vercel-artifacts")]
VercelArtifacts,
#[cfg(feature = "services-webdav")]
Webdav,
#[cfg(feature = "services-webhdfs")]
Webhdfs,
#[cfg(feature = "services-yandex-disk")]
YandexDisk,
}
#[gen_stub_pymethods]
#[pymethods]
impl PyScheme {
#[getter]
pub fn name(&self) -> String {
format!("{:?}", &self)
}
#[getter]
pub fn value(&self) -> &'static str {
(*self).into()
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.AliyunDrive, typing.Literal["aliyun-drive"]],
/,
*,
access_token: builtins.str = ...,
client_id: builtins.str = ...,
client_secret: builtins.str = ...,
drive_type: builtins.str,
refresh_token: builtins.str = ...,
root: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `aliyun-drive` service.
Parameters
----------
access_token : builtins.str, optional
The access_token of this backend.
Solution for client-only purpose.
#4733 Required if no client_id, client_secret and
refresh_token are provided.
client_id : builtins.str, optional
The client_id of this backend.
Required if no access_token is provided.
client_secret : builtins.str, optional
The client_secret of this backend.
Required if no access_token is provided.
drive_type : builtins.str
The drive_type of this backend.
All operations will happen under this type of drive.
Available values are `default`, `backup` and
`resource`.
Fallback to default if not set or no other drives
can be found.
refresh_token : builtins.str, optional
The refresh_token of this backend.
Required if no access_token is provided.
root : builtins.str, optional
The Root of this backend.
All operations will happen under this root.
Default to `/` if not set.
Returns
-------
Operator
The new `Operator` for `aliyun-drive` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Alluxio, typing.Literal["alluxio"]],
/,
*,
endpoint: builtins.str = ...,
root: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `alluxio` service.
Parameters
----------
endpoint : builtins.str, optional
endpoint of this backend.
Endpoint must be full uri, mostly like
`http://127.0.0.1:39999`.
root : builtins.str, optional
root of this backend.
All operations will happen under this root.
default to `/` if not set.
Returns
-------
Operator
The new `Operator` for `alluxio` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Azblob, typing.Literal["azblob"]],
/,
*,
account_key: builtins.str = ...,
account_name: builtins.str = ...,
batch_max_operations: builtins.int = ...,
container: builtins.str,
encryption_algorithm: builtins.str = ...,
encryption_key: builtins.str = ...,
encryption_key_sha256: builtins.str = ...,
endpoint: builtins.str = ...,
root: builtins.str = ...,
sas_token: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `azblob` service.
Parameters
----------
account_key : builtins.str, optional
The account key of Azblob service backend.
account_name : builtins.str, optional
The account name of Azblob service backend.
batch_max_operations : builtins.int, optional
The maximum batch operations of Azblob service
backend.
container : builtins.str
The container name of Azblob service backend.
encryption_algorithm : builtins.str, optional
The encryption algorithm of Azblob service backend.
encryption_key : builtins.str, optional
The encryption key of Azblob service backend.
encryption_key_sha256 : builtins.str, optional
The encryption key sha256 of Azblob service backend.
endpoint : builtins.str, optional
The endpoint of Azblob service backend.
Endpoint must be full uri, e.g.
- Azblob:
`https://accountname.blob.core.windows.net` -
Azurite: `http://127.0.0.1:10000/devstoreaccount1`
root : builtins.str, optional
The root of Azblob service backend.
All operations will happen under this root.
sas_token : builtins.str, optional
The sas token of Azblob service backend.
Returns
-------
Operator
The new `Operator` for `azblob` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Azdls, typing.Literal["azdls"]],
/,
*,
account_key: builtins.str = ...,
account_name: builtins.str = ...,
authority_host: builtins.str = ...,
client_id: builtins.str = ...,
client_secret: builtins.str = ...,
endpoint: builtins.str = ...,
filesystem: builtins.str,
root: builtins.str = ...,
sas_token: builtins.str = ...,
tenant_id: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `azdls` service.
Parameters
----------
account_key : builtins.str, optional
Account key of this backend.
- required for shared_key authentication
account_name : builtins.str, optional
Account name of this backend.
authority_host : builtins.str, optional
authority_host The authority host of the service
principal.
- required for client_credentials authentication -
default value: `https://login.microsoftonline.com`
client_id : builtins.str, optional
client_id The client id of the service principal.
- required for client_credentials authentication
client_secret : builtins.str, optional
client_secret The client secret of the service
principal.
- required for client_credentials authentication
endpoint : builtins.str, optional
Endpoint of this backend.
filesystem : builtins.str
Filesystem name of this backend.
root : builtins.str, optional
Root of this backend.
sas_token : builtins.str, optional
sas_token The shared access signature token.
- required for sas authentication
tenant_id : builtins.str, optional
tenant_id The tenant id of the service principal.
- required for client_credentials authentication
Returns
-------
Operator
The new `Operator` for `azdls` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Azfile, typing.Literal["azfile"]],
/,
*,
account_key: builtins.str = ...,
account_name: builtins.str = ...,
endpoint: builtins.str = ...,
root: builtins.str = ...,
sas_token: builtins.str = ...,
share_name: builtins.str,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `azfile` service.
Parameters
----------
account_key : builtins.str, optional
The account key for azfile.
account_name : builtins.str, optional
The account name for azfile.
endpoint : builtins.str, optional
The endpoint for azfile.
root : builtins.str, optional
The root path for azfile.
sas_token : builtins.str, optional
The sas token for azfile.
share_name : builtins.str
The share name for azfile.
Returns
-------
Operator
The new `Operator` for `azfile` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.B2, typing.Literal["b2"]],
/,
*,
application_key: builtins.str = ...,
application_key_id: builtins.str = ...,
bucket: builtins.str,
bucket_id: builtins.str,
root: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `b2` service.
Parameters
----------
application_key : builtins.str, optional
applicationKey of this backend.
- If application_key is set, we will take user's
input first.
- If not, we will try to load it from environment.
application_key_id : builtins.str, optional
keyID of this backend.
- If application_key_id is set, we will take user's
input first.
- If not, we will try to load it from environment.
bucket : builtins.str
bucket of this backend.
required.
bucket_id : builtins.str
bucket id of this backend.
required.
root : builtins.str, optional
root of this backend.
All operations will happen under this root.
Returns
-------
Operator
The new `Operator` for `b2` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Cacache, typing.Literal["cacache"]],
/,
*,
datadir: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `cacache` service.
Parameters
----------
datadir : builtins.str, optional
That path to the cacache data directory.
Returns
-------
Operator
The new `Operator` for `cacache` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Cos, typing.Literal["cos"]],
/,
*,
bucket: builtins.str = ...,
disable_config_load: builtins.bool = ...,
enable_versioning: builtins.bool = ...,
endpoint: builtins.str = ...,
root: builtins.str = ...,
secret_id: builtins.str = ...,
secret_key: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `cos` service.
Parameters
----------
bucket : builtins.str, optional
Bucket of this backend.
disable_config_load : builtins.bool, optional
Disable config load so that opendal will not load
config from
enable_versioning : builtins.bool, optional
is bucket versioning enabled for this bucket
endpoint : builtins.str, optional
Endpoint of this backend.
root : builtins.str, optional
Root of this backend.
secret_id : builtins.str, optional
Secret ID of this backend.
secret_key : builtins.str, optional
Secret key of this backend.
Returns
-------
Operator
The new `Operator` for `cos` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Dashmap, typing.Literal["dashmap"]],
/,
*,
root: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `dashmap` service.
Parameters
----------
root : builtins.str, optional
root path of this backend
Returns
-------
Operator
The new `Operator` for `dashmap` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Dropbox, typing.Literal["dropbox"]],
/,
*,
access_token: builtins.str = ...,
client_id: builtins.str = ...,
client_secret: builtins.str = ...,
refresh_token: builtins.str = ...,
root: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `dropbox` service.
Parameters
----------
access_token : builtins.str, optional
access token for dropbox.
client_id : builtins.str, optional
client_id for dropbox.
client_secret : builtins.str, optional
client_secret for dropbox.
refresh_token : builtins.str, optional
refresh_token for dropbox.
root : builtins.str, optional
root path for dropbox.
Returns
-------
Operator
The new `Operator` for `dropbox` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Fs, typing.Literal["fs"]],
/,
*,
atomic_write_dir: builtins.str = ...,
root: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `fs` service.
Parameters
----------
atomic_write_dir : builtins.str, optional
tmp dir for atomic write
root : builtins.str, optional
root dir for backend
Returns
-------
Operator
The new `Operator` for `fs` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Ftp, typing.Literal["ftp"]],
/,
*,
endpoint: builtins.str = ...,
password: builtins.str = ...,
root: builtins.str = ...,
user: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `ftp` service.
Parameters
----------
endpoint : builtins.str, optional
endpoint of this backend
password : builtins.str, optional
password of this backend
root : builtins.str, optional
root of this backend
user : builtins.str, optional
user of this backend
Returns
-------
Operator
The new `Operator` for `ftp` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Gcs, typing.Literal["gcs"]],
/,
*,
allow_anonymous: builtins.bool = ...,
bucket: builtins.str,
credential: builtins.str = ...,
credential_path: builtins.str = ...,
default_storage_class: builtins.str = ...,
disable_config_load: builtins.bool = ...,
disable_vm_metadata: builtins.bool = ...,
endpoint: builtins.str = ...,
predefined_acl: builtins.str = ...,
root: builtins.str = ...,
scope: builtins.str = ...,
service_account: builtins.str = ...,
token: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `gcs` service.
Parameters
----------
allow_anonymous : builtins.bool, optional
Allow opendal to send requests without signing when
credentials are not loaded.
bucket : builtins.str
bucket name
credential : builtins.str, optional
Credentials string for GCS service OAuth2
authentication.
credential_path : builtins.str, optional
Local path to credentials file for GCS service
OAuth2 authentication.
default_storage_class : builtins.str, optional
The default storage class used by gcs.
disable_config_load : builtins.bool, optional
Disable loading configuration from the environment.
disable_vm_metadata : builtins.bool, optional
Disable attempting to load credentials from the GCE
metadata server when running within Google Cloud.
endpoint : builtins.str, optional
endpoint URI of GCS service, default is
`https://storage.googleapis.com`
predefined_acl : builtins.str, optional
The predefined acl for GCS.
root : builtins.str, optional
root URI, all operations happens under `root`
scope : builtins.str, optional
Scope for gcs.
service_account : builtins.str, optional
Service Account for gcs.
token : builtins.str, optional
A Google Cloud OAuth2 token.
Takes precedence over `credential` and
`credential_path`.
Returns
-------
Operator
The new `Operator` for `gcs` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Gdrive, typing.Literal["gdrive"]],
/,
*,
access_token: builtins.str = ...,
client_id: builtins.str = ...,
client_secret: builtins.str = ...,
refresh_token: builtins.str = ...,
root: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `gdrive` service.
Parameters
----------
access_token : builtins.str, optional
Access token for gdrive.
client_id : builtins.str, optional
Client id for gdrive.
client_secret : builtins.str, optional
Client secret for gdrive.
refresh_token : builtins.str, optional
Refresh token for gdrive.
root : builtins.str, optional
The root for gdrive
Returns
-------
Operator
The new `Operator` for `gdrive` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Ghac, typing.Literal["ghac"]],
/,
*,
endpoint: builtins.str = ...,
root: builtins.str = ...,
runtime_token: builtins.str = ...,
version: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `ghac` service.
Parameters
----------
endpoint : builtins.str, optional
The endpoint for ghac service.
root : builtins.str, optional
The root path for ghac.
runtime_token : builtins.str, optional
The runtime token for ghac service.
version : builtins.str, optional
The version that used by cache.
Returns
-------
Operator
The new `Operator` for `ghac` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Gridfs, typing.Literal["gridfs"]],
/,
*,
bucket: builtins.str = ...,
chunk_size: builtins.int = ...,
connection_string: builtins.str = ...,
database: builtins.str = ...,
root: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `gridfs` service.
Parameters
----------
bucket : builtins.str, optional
The bucket name of the MongoDB GridFs service to
read/write.
chunk_size : builtins.int, optional
The chunk size of the MongoDB GridFs service used to
break the user file into chunks.
connection_string : builtins.str, optional
The connection string of the MongoDB service.
database : builtins.str, optional
The database name of the MongoDB GridFs service to
read/write.
root : builtins.str, optional
The working directory, all operations will be
performed under it.
Returns
-------
Operator
The new `Operator` for `gridfs` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.HdfsNative, typing.Literal["hdfs-native"]],
/,
*,
enable_append: builtins.bool = ...,
name_node: builtins.str = ...,
root: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `hdfs-native` service.
Parameters
----------
enable_append : builtins.bool, optional
enable the append capacity
name_node : builtins.str, optional
name_node of this backend
root : builtins.str, optional
work dir of this backend
Returns
-------
Operator
The new `Operator` for `hdfs-native` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Http, typing.Literal["http"]],
/,
*,
endpoint: builtins.str = ...,
password: builtins.str = ...,
root: builtins.str = ...,
token: builtins.str = ...,
username: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `http` service.
Parameters
----------
endpoint : builtins.str, optional
endpoint of this backend
password : builtins.str, optional
password of this backend
root : builtins.str, optional
root of this backend
token : builtins.str, optional
token of this backend
username : builtins.str, optional
username of this backend
Returns
-------
Operator
The new `Operator` for `http` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Huggingface, typing.Literal["huggingface"]],
/,
*,
endpoint: builtins.str = ...,
repo_id: builtins.str = ...,
repo_type: builtins.str = ...,
revision: builtins.str = ...,
root: builtins.str = ...,
token: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `huggingface` service.
Parameters
----------
endpoint : builtins.str, optional
Endpoint of the Huggingface Hub.
Default is "https://huggingface.co".
repo_id : builtins.str, optional
Repo id of this backend.
This is required.
repo_type : builtins.str, optional
Repo type of this backend.
Default is model.
Available values: - model - dataset - datasets
(alias for dataset)
revision : builtins.str, optional
Revision of this backend.
Default is main.
root : builtins.str, optional
Root of this backend.
Can be "/path/to/dir".
Default is "/".
token : builtins.str, optional
Token of this backend.
This is optional.
Returns
-------
Operator
The new `Operator` for `huggingface` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Ipfs, typing.Literal["ipfs"]],
/,
*,
endpoint: builtins.str = ...,
root: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `ipfs` service.
Parameters
----------
endpoint : builtins.str, optional
IPFS gateway endpoint.
root : builtins.str, optional
IPFS root.
Returns
-------
Operator
The new `Operator` for `ipfs` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Ipmfs, typing.Literal["ipmfs"]],
/,
*,
endpoint: builtins.str = ...,
root: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `ipmfs` service.
Parameters
----------
endpoint : builtins.str, optional
Endpoint for ipfs.
root : builtins.str, optional
Root for ipfs.
Returns
-------
Operator
The new `Operator` for `ipmfs` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Koofr, typing.Literal["koofr"]],
/,
*,
email: builtins.str,
endpoint: builtins.str,
password: builtins.str = ...,
root: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `koofr` service.
Parameters
----------
email : builtins.str
Koofr email.
endpoint : builtins.str
Koofr endpoint.
password : builtins.str, optional
password of this backend.
(Must be the application password)
root : builtins.str, optional
root of this backend.
All operations will happen under this root.
Returns
-------
Operator
The new `Operator` for `koofr` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Memcached, typing.Literal["memcached"]],
/,
*,
connection_pool_max_size: builtins.int = ...,
default_ttl: typing.Any = ...,
endpoint: builtins.str = ...,
password: builtins.str = ...,
root: builtins.str = ...,
username: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `memcached` service.
Parameters
----------
connection_pool_max_size : builtins.int, optional
The maximum number of connections allowed.
default is 10
default_ttl : typing.Any, optional
The default ttl for put operations..
a human readable duration string see
https://docs.rs/humantime/latest/humantime/fn.parse_duration.html
for more details
endpoint : builtins.str, optional
network address of the memcached service.
For example: "tcp://localhost:11211"
password : builtins.str, optional
Memcached password, optional.
root : builtins.str, optional
the working directory of the service.
Can be "/path/to/dir" default is "/"
username : builtins.str, optional
Memcached username, optional.
Returns
-------
Operator
The new `Operator` for `memcached` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Memory, typing.Literal["memory"]],
/,
*,
root: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `memory` service.
Parameters
----------
root : builtins.str, optional
root of the backend.
Returns
-------
Operator
The new `Operator` for `memory` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.MiniMoka, typing.Literal["mini-moka"]],
/,
*,
max_capacity: builtins.int = ...,
root: builtins.str = ...,
time_to_idle: builtins.str = ...,
time_to_live: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `mini-moka` service.
Parameters
----------
max_capacity : builtins.int, optional
Sets the max capacity of the cache.
Refer to
[`mini-moka::sync::CacheBuilder::max_capacity`](https://docs.rs/mini-moka/latest/mini_moka/sync/struct.CacheBuilder.html#method.max_capacity)
root : builtins.str, optional
root path of this backend
time_to_idle : builtins.str, optional
Sets the time to idle of the cache.
Refer to
[`mini-moka::sync::CacheBuilder::time_to_idle`](https://docs.rs/mini-moka/latest/mini_moka/sync/struct.CacheBuilder.html#method.time_to_idle)
time_to_live : builtins.str, optional
Sets the time to live of the cache.
Refer to
[`mini-moka::sync::CacheBuilder::time_to_live`](https://docs.rs/mini-moka/latest/mini_moka/sync/struct.CacheBuilder.html#method.time_to_live)
Returns
-------
Operator
The new `Operator` for `mini-moka` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Moka, typing.Literal["moka"]],
/,
*,
max_capacity: builtins.int = ...,
name: builtins.str = ...,
root: builtins.str = ...,
time_to_idle: builtins.str = ...,
time_to_live: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `moka` service.
Parameters
----------
max_capacity : builtins.int, optional
Sets the max capacity of the cache.
Refer to
[`moka::future::CacheBuilder::max_capacity`](https://docs.rs/moka/latest/moka/future/struct.CacheBuilder.html#method.max_capacity)
name : builtins.str, optional
Name for this cache instance.
root : builtins.str, optional
root path of this backend
time_to_idle : builtins.str, optional
Sets the time to idle of the cache.
Refer to
[`moka::future::CacheBuilder::time_to_idle`](https://docs.rs/moka/latest/moka/future/struct.CacheBuilder.html#method.time_to_idle)
time_to_live : builtins.str, optional
Sets the time to live of the cache.
Refer to
[`moka::future::CacheBuilder::time_to_live`](https://docs.rs/moka/latest/moka/future/struct.CacheBuilder.html#method.time_to_live)
Returns
-------
Operator
The new `Operator` for `moka` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Mongodb, typing.Literal["mongodb"]],
/,
*,
collection: builtins.str = ...,
connection_string: builtins.str = ...,
database: builtins.str = ...,
key_field: builtins.str = ...,
root: builtins.str = ...,
value_field: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `mongodb` service.
Parameters
----------
collection : builtins.str, optional
collection of this backend
connection_string : builtins.str, optional
connection string of this backend
database : builtins.str, optional
database of this backend
key_field : builtins.str, optional
key field of this backend
root : builtins.str, optional
root of this backend
value_field : builtins.str, optional
value field of this backend
Returns
-------
Operator
The new `Operator` for `mongodb` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Mysql, typing.Literal["mysql"]],
/,
*,
connection_string: builtins.str = ...,
key_field: builtins.str = ...,
root: builtins.str = ...,
table: builtins.str = ...,
value_field: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `mysql` service.
Parameters
----------
connection_string : builtins.str, optional
This connection string is used to connect to the
mysql service.
There are url based formats.
The format of connect string resembles the url
format of the mysql client.
The format is:
`[scheme://][user[:[password]]@]host[:port][/schema][?attribute1=value1&attribute2=value2...`
- `mysql://user@localhost` -
`mysql://user:password@localhost` -
`mysql://user:password@localhost:3306` -
`mysql://user:password@localhost:3306/db` For more
information, please refer to
<https://docs.rs/sqlx/latest/sqlx/mysql/struct.MySqlConnectOptions.html>.
key_field : builtins.str, optional
The key field name for mysql.
root : builtins.str, optional
The root for mysql.
table : builtins.str, optional
The table name for mysql.
value_field : builtins.str, optional
The value field name for mysql.
Returns
-------
Operator
The new `Operator` for `mysql` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Obs, typing.Literal["obs"]],
/,
*,
access_key_id: builtins.str = ...,
bucket: builtins.str = ...,
enable_versioning: builtins.bool = ...,
endpoint: builtins.str = ...,
root: builtins.str = ...,
secret_access_key: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `obs` service.
Parameters
----------
access_key_id : builtins.str, optional
Access key id for obs.
bucket : builtins.str, optional
Bucket for obs.
enable_versioning : builtins.bool, optional
Is bucket versioning enabled for this bucket
endpoint : builtins.str, optional
Endpoint for obs.
root : builtins.str, optional
Root for obs.
secret_access_key : builtins.str, optional
Secret access key for obs.
Returns
-------
Operator
The new `Operator` for `obs` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Onedrive, typing.Literal["onedrive"]],
/,
*,
access_token: builtins.str = ...,
client_id: builtins.str = ...,
client_secret: builtins.str = ...,
enable_versioning: builtins.bool = ...,
refresh_token: builtins.str = ...,
root: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `onedrive` service.
Parameters
----------
access_token : builtins.str, optional
Microsoft Graph API (also OneDrive API) access token
client_id : builtins.str, optional
Microsoft Graph API Application (client) ID that is
in the Azure's app registration portal
client_secret : builtins.str, optional
Microsoft Graph API Application client secret that
is in the Azure's app registration portal
enable_versioning : builtins.bool, optional
Enabling version support
refresh_token : builtins.str, optional
Microsoft Graph API (also OneDrive API) refresh
token
root : builtins.str, optional
The root path for the OneDrive service for the file
access
Returns
-------
Operator
The new `Operator` for `onedrive` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Oss, typing.Literal["oss"]],
/,
*,
access_key_id: builtins.str = ...,
access_key_secret: builtins.str = ...,
addressing_style: builtins.str = ...,
allow_anonymous: builtins.bool = ...,
batch_max_operations: builtins.int = ...,
bucket: builtins.str,
delete_max_size: builtins.int = ...,
enable_versioning: builtins.bool = ...,
endpoint: builtins.str = ...,
oidc_provider_arn: builtins.str = ...,
oidc_token_file: builtins.str = ...,
presign_addressing_style: builtins.str = ...,
presign_endpoint: builtins.str = ...,
role_arn: builtins.str = ...,
role_session_name: builtins.str = ...,
root: builtins.str = ...,
security_token: builtins.str = ...,
server_side_encryption: builtins.str = ...,
server_side_encryption_key_id: builtins.str = ...,
sts_endpoint: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `oss` service.
Parameters
----------
access_key_id : builtins.str, optional
Access key id for oss.
- this field if it's `is_some` - env value:
[`ALIBABA_CLOUD_ACCESS_KEY_ID`]
access_key_secret : builtins.str, optional
Access key secret for oss.
- this field if it's `is_some` - env value:
[`ALIBABA_CLOUD_ACCESS_KEY_SECRET`]
addressing_style : builtins.str, optional
Addressing style for oss.
allow_anonymous : builtins.bool, optional
Allow anonymous for oss.
batch_max_operations : builtins.int, optional
The size of max batch operations.
bucket : builtins.str
Bucket for oss.
delete_max_size : builtins.int, optional
The size of max delete operations.
enable_versioning : builtins.bool, optional
is bucket versioning enabled for this bucket
endpoint : builtins.str, optional
Endpoint for oss.
oidc_provider_arn : builtins.str, optional
`oidc_provider_arn` will be loaded from - this field
if it's `is_some` - env value:
[`ALIBABA_CLOUD_OIDC_PROVIDER_ARN`]
oidc_token_file : builtins.str, optional
`oidc_token_file` will be loaded from - this field
if it's `is_some` - env value:
[`ALIBABA_CLOUD_OIDC_TOKEN_FILE`]
presign_addressing_style : builtins.str, optional
Pre sign addressing style for oss.
presign_endpoint : builtins.str, optional
Presign endpoint for oss.
role_arn : builtins.str, optional
If `role_arn` is set, we will use already known
config as source credential to assume role with
`role_arn`.
- this field if it's `is_some` - env value:
[`ALIBABA_CLOUD_ROLE_ARN`]
role_session_name : builtins.str, optional
role_session_name for this backend.
root : builtins.str, optional
Root for oss.
security_token : builtins.str, optional
`security_token` will be loaded from - this field if
it's `is_some` - env value:
[`ALIBABA_CLOUD_SECURITY_TOKEN`]
server_side_encryption : builtins.str, optional
Server side encryption for oss.
server_side_encryption_key_id : builtins.str, optional
Server side encryption key id for oss.
sts_endpoint : builtins.str, optional
`sts_endpoint` will be loaded from - this field if
it's `is_some` - env value:
[`ALIBABA_CLOUD_STS_ENDPOINT`]
Returns
-------
Operator
The new `Operator` for `oss` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Persy, typing.Literal["persy"]],
/,
*,
datafile: builtins.str = ...,
index: builtins.str = ...,
segment: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `persy` service.
Parameters
----------
datafile : builtins.str, optional
That path to the persy data file.
The directory in the path must already exist.
index : builtins.str, optional
That name of the persy index.
segment : builtins.str, optional
That name of the persy segment.
Returns
-------
Operator
The new `Operator` for `persy` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Postgresql, typing.Literal["postgresql"]],
/,
*,
connection_string: builtins.str = ...,
key_field: builtins.str = ...,
root: builtins.str = ...,
table: builtins.str = ...,
value_field: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `postgresql` service.
Parameters
----------
connection_string : builtins.str, optional
The URL should be with a scheme of either
`postgres://` or `postgresql://`.
- `postgresql://user@localhost` -
`postgresql://user:password@%2Fvar%2Flib%2Fpostgresql/mydb?connect_timeout=10`
-
`postgresql://user@host1:1234,host2,host3:5678?target_session_attrs=read-write`
-
`postgresql:///mydb?user=user&host=/var/lib/postgresql`
For more information, please visit
<https://docs.rs/sqlx/latest/sqlx/postgres/struct.PgConnectOptions.html>.
key_field : builtins.str, optional
the key field of postgresql
root : builtins.str, optional
Root of this backend.
All operations will happen under this root.
Default to `/` if not set.
table : builtins.str, optional
the table of postgresql
value_field : builtins.str, optional
the value field of postgresql
Returns
-------
Operator
The new `Operator` for `postgresql` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Redb, typing.Literal["redb"]],
/,
*,
datadir: builtins.str = ...,
root: builtins.str = ...,
table: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `redb` service.
Parameters
----------
datadir : builtins.str, optional
path to the redb data directory.
root : builtins.str, optional
The root for redb.
table : builtins.str, optional
The table name for redb.
Returns
-------
Operator
The new `Operator` for `redb` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Redis, typing.Literal["redis"]],
/,
*,
cluster_endpoints: builtins.str = ...,
connection_pool_max_size: builtins.int = ...,
db: builtins.int,
default_ttl: typing.Any = ...,
endpoint: builtins.str = ...,
password: builtins.str = ...,
root: builtins.str = ...,
username: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `redis` service.
Parameters
----------
cluster_endpoints : builtins.str, optional
network address of the Redis cluster service.
Can be
"tcp://127.0.0.1:6379,tcp://127.0.0.1:6380,tcp://127.0.0.1:6381",
e.g.
default is None
connection_pool_max_size : builtins.int, optional
The maximum number of connections allowed.
default is 10
db : builtins.int
the number of DBs redis can take is unlimited
default is db 0
default_ttl : typing.Any, optional
The default ttl for put operations..
a human readable duration string see
https://docs.rs/humantime/latest/humantime/fn.parse_duration.html
for more details
endpoint : builtins.str, optional
network address of the Redis service.
Can be "tcp://127.0.0.1:6379", e.g.
default is "tcp://127.0.0.1:6379"
password : builtins.str, optional
the password for authentication default is None
root : builtins.str, optional
the working directory of the Redis service.
Can be "/path/to/dir" default is "/"
username : builtins.str, optional
the username to connect redis service.
default is None
Returns
-------
Operator
The new `Operator` for `redis` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.S3, typing.Literal["s3"]],
/,
*,
access_key_id: builtins.str = ...,
allow_anonymous: builtins.bool = ...,
batch_max_operations: builtins.int = ...,
bucket: builtins.str,
checksum_algorithm: builtins.str = ...,
default_storage_class: builtins.str = ...,
delete_max_size: builtins.int = ...,
disable_config_load: builtins.bool = ...,
disable_ec2_metadata: builtins.bool = ...,
disable_list_objects_v2: builtins.bool = ...,
disable_stat_with_override: builtins.bool = ...,
disable_write_with_if_match: builtins.bool = ...,
enable_request_payer: builtins.bool = ...,
enable_versioning: builtins.bool = ...,
enable_virtual_host_style: builtins.bool = ...,
enable_write_with_append: builtins.bool = ...,
endpoint: builtins.str = ...,
external_id: builtins.str = ...,
region: builtins.str = ...,
role_arn: builtins.str = ...,
role_session_name: builtins.str = ...,
root: builtins.str = ...,
secret_access_key: builtins.str = ...,
server_side_encryption: builtins.str = ...,
server_side_encryption_aws_kms_key_id: builtins.str = ...,
server_side_encryption_customer_algorithm: builtins.str = ...,
server_side_encryption_customer_key: builtins.str = ...,
server_side_encryption_customer_key_md5: builtins.str = ...,
session_token: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `s3` service.
Parameters
----------
access_key_id : builtins.str, optional
access_key_id of this backend.
- If access_key_id is set, we will take user's input
first.
- If not, we will try to load it from environment.
allow_anonymous : builtins.bool, optional
Allow anonymous will allow opendal to send request
without signing when credential is not loaded.
batch_max_operations : builtins.int, optional
Set maximum batch operations of this backend.
Some compatible services have a limit on the number
of operations in a batch request.
For example, R2 could return `Internal Error` while
batch delete 1000 files.
Please tune this value based on services' document.
bucket : builtins.str
bucket name of this backend.
required.
checksum_algorithm : builtins.str, optional
Checksum Algorithm to use when sending checksums in
HTTP headers.
This is necessary when writing to AWS S3 Buckets
with Object Lock enabled for example.
Available options: - "crc32c" - "md5"
default_storage_class : builtins.str, optional
default storage_class for this backend.
Available values: - `DEEP_ARCHIVE` - `GLACIER` -
`GLACIER_IR` - `INTELLIGENT_TIERING` - `ONEZONE_IA`
- `EXPRESS_ONEZONE` - `OUTPOSTS` -
`REDUCED_REDUNDANCY` - `STANDARD` - `STANDARD_IA` S3
compatible services don't support all of them
delete_max_size : builtins.int, optional
Set the maximum delete size of this backend.
Some compatible services have a limit on the number
of operations in a batch request.
For example, R2 could return `Internal Error` while
batch delete 1000 files.
Please tune this value based on services' document.
disable_config_load : builtins.bool, optional
Disable config load so that opendal will not load
config from environment.
For examples: - envs like `AWS_ACCESS_KEY_ID` -
files like `~/.aws/config`
disable_ec2_metadata : builtins.bool, optional
Disable load credential from ec2 metadata.
This option is used to disable the default behavior
of opendal to load credential from ec2 metadata,
a.k.a., IMDSv2
disable_list_objects_v2 : builtins.bool, optional
OpenDAL uses List Objects V2 by default to list
objects.
However, some legacy services do not yet support V2.
This option allows users to switch back to the older
List Objects V1.
disable_stat_with_override : builtins.bool, optional
Disable stat with override so that opendal will not
send stat request with override queries.
For example, R2 doesn't support stat with
`response_content_type` query.
disable_write_with_if_match : builtins.bool, optional
Disable write with if match so that opendal will not
send write request with if match headers.
For example, Ceph RADOS S3 doesn't support write
with if matched.
enable_request_payer : builtins.bool, optional
Indicates whether the client agrees to pay for the
requests made to the S3 bucket.
enable_versioning : builtins.bool, optional
is bucket versioning enabled for this bucket
enable_virtual_host_style : builtins.bool, optional
Enable virtual host style so that opendal will send
API requests in virtual host style instead of path
style.
- By default, opendal will send API to
`https://s3.us-east-1.amazonaws.com/bucket_name` -
Enabled, opendal will send API to
`https://bucket_name.s3.us-east-1.amazonaws.com`
enable_write_with_append : builtins.bool, optional
Enable write with append so that opendal will send
write request with append headers.
endpoint : builtins.str, optional
endpoint of this backend.
Endpoint must be full uri, e.g.
- AWS S3: `https://s3.amazonaws.com` or
`https://s3.{region}.amazonaws.com` - Cloudflare R2:
`https://<ACCOUNT_ID>.r2.cloudflarestorage.com` -
Aliyun OSS: `https://{region}.aliyuncs.com` -
Tencent COS: `https://cos.{region}.myqcloud.com` -
Minio: `http://127.0.0.1:9000` If user inputs
endpoint without scheme like "s3.amazonaws.com", we
will prepend "https://" before it.
- If endpoint is set, we will take user's input
first.
- If not, we will try to load it from environment.
- If still not set, default to
`https://s3.amazonaws.com`.
external_id : builtins.str, optional
external_id for this backend.
region : builtins.str, optional
Region represent the signing region of this
endpoint.
This is required if you are using the default AWS S3
endpoint.
If using a custom endpoint, - If region is set, we
will take user's input first.
- If not, we will try to load it from environment.
role_arn : builtins.str, optional
role_arn for this backend.
If `role_arn` is set, we will use already known
config as source credential to assume role with
`role_arn`.
role_session_name : builtins.str, optional
role_session_name for this backend.
root : builtins.str, optional
root of this backend.
All operations will happen under this root.
default to `/` if not set.
secret_access_key : builtins.str, optional
secret_access_key of this backend.
- If secret_access_key is set, we will take user's
input first.
- If not, we will try to load it from environment.
server_side_encryption : builtins.str, optional
server_side_encryption for this backend.
Available values: `AES256`, `aws:kms`.
server_side_encryption_aws_kms_key_id : builtins.str, optional
server_side_encryption_aws_kms_key_id for this
backend - If `server_side_encryption` set to
`aws:kms`, and
`server_side_encryption_aws_kms_key_id` is not set,
S3 will use aws managed kms key to encrypt data.
- If `server_side_encryption` set to `aws:kms`, and
`server_side_encryption_aws_kms_key_id` is a valid
kms key id, S3 will use the provided kms key to
encrypt data.
- If the `server_side_encryption_aws_kms_key_id` is
invalid or not found, an error will be returned.
- If `server_side_encryption` is not `aws:kms`,
setting `server_side_encryption_aws_kms_key_id` is a
noop.
server_side_encryption_customer_algorithm : builtins.str, optional
server_side_encryption_customer_algorithm for this
backend.
Available values: `AES256`.
server_side_encryption_customer_key : builtins.str, optional
server_side_encryption_customer_key for this
backend.
Value: BASE64-encoded key that matches algorithm
specified in
`server_side_encryption_customer_algorithm`.
server_side_encryption_customer_key_md5 : builtins.str, optional
Set server_side_encryption_customer_key_md5 for this
backend.
Value: MD5 digest of key specified in
`server_side_encryption_customer_key`.
session_token : builtins.str, optional
session_token (aka, security token) of this backend.
This token will expire after sometime, it's
recommended to set session_token by hand.
Returns
-------
Operator
The new `Operator` for `s3` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Seafile, typing.Literal["seafile"]],
/,
*,
endpoint: builtins.str = ...,
password: builtins.str = ...,
repo_name: builtins.str,
root: builtins.str = ...,
username: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `seafile` service.
Parameters
----------
endpoint : builtins.str, optional
endpoint address of this backend.
password : builtins.str, optional
password of this backend.
repo_name : builtins.str
repo_name of this backend.
required.
root : builtins.str, optional
root of this backend.
All operations will happen under this root.
username : builtins.str, optional
username of this backend.
Returns
-------
Operator
The new `Operator` for `seafile` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Sftp, typing.Literal["sftp"]],
/,
*,
enable_copy: builtins.bool = ...,
endpoint: builtins.str = ...,
key: builtins.str = ...,
known_hosts_strategy: builtins.str = ...,
root: builtins.str = ...,
user: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `sftp` service.
Parameters
----------
enable_copy : builtins.bool, optional
enable_copy of this backend
endpoint : builtins.str, optional
endpoint of this backend
key : builtins.str, optional
key of this backend
known_hosts_strategy : builtins.str, optional
known_hosts_strategy of this backend
root : builtins.str, optional
root of this backend
user : builtins.str, optional
user of this backend
Returns
-------
Operator
The new `Operator` for `sftp` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Sled, typing.Literal["sled"]],
/,
*,
datadir: builtins.str = ...,
root: builtins.str = ...,
tree: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `sled` service.
Parameters
----------
datadir : builtins.str, optional
That path to the sled data directory.
root : builtins.str, optional
The root for sled.
tree : builtins.str, optional
The tree for sled.
Returns
-------
Operator
The new `Operator` for `sled` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Sqlite, typing.Literal["sqlite"]],
/,
*,
connection_string: builtins.str = ...,
key_field: builtins.str = ...,
root: builtins.str = ...,
table: builtins.str = ...,
value_field: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `sqlite` service.
Parameters
----------
connection_string : builtins.str, optional
Set the connection_string of the sqlite service.
This connection string is used to connect to the
sqlite service.
The format of connect string resembles the url
format of the sqlite client: - `sqlite::memory:` -
`sqlite:data.db` - `sqlite://data.db` For more
information, please visit
<https://docs.rs/sqlx/latest/sqlx/sqlite/struct.SqliteConnectOptions.html>.
key_field : builtins.str, optional
Set the key field name of the sqlite service to
read/write.
Default to `key` if not specified.
root : builtins.str, optional
set the working directory, all operations will be
performed under it.
default: "/"
table : builtins.str, optional
Set the table name of the sqlite service to
read/write.
value_field : builtins.str, optional
Set the value field name of the sqlite service to
read/write.
Default to `value` if not specified.
Returns
-------
Operator
The new `Operator` for `sqlite` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Swift, typing.Literal["swift"]],
/,
*,
container: builtins.str = ...,
endpoint: builtins.str = ...,
root: builtins.str = ...,
token: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `swift` service.
Parameters
----------
container : builtins.str, optional
The container for Swift.
endpoint : builtins.str, optional
The endpoint for Swift.
root : builtins.str, optional
The root for Swift.
token : builtins.str, optional
The token for Swift.
Returns
-------
Operator
The new `Operator` for `swift` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Upyun, typing.Literal["upyun"]],
/,
*,
bucket: builtins.str,
operator: builtins.str = ...,
password: builtins.str = ...,
root: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `upyun` service.
Parameters
----------
bucket : builtins.str
bucket address of this backend.
operator : builtins.str, optional
username of this backend.
password : builtins.str, optional
password of this backend.
root : builtins.str, optional
root of this backend.
All operations will happen under this root.
Returns
-------
Operator
The new `Operator` for `upyun` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.VercelArtifacts, typing.Literal["vercel-artifacts"]],
/,
*,
access_token: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `vercel-artifacts` service.
Parameters
----------
access_token : builtins.str, optional
The access token for Vercel.
Returns
-------
Operator
The new `Operator` for `vercel-artifacts` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Webdav, typing.Literal["webdav"]],
/,
*,
disable_copy: builtins.bool = ...,
endpoint: builtins.str = ...,
password: builtins.str = ...,
root: builtins.str = ...,
token: builtins.str = ...,
username: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `webdav` service.
Parameters
----------
disable_copy : builtins.bool, optional
WebDAV Service doesn't support copy.
endpoint : builtins.str, optional
endpoint of this backend
password : builtins.str, optional
password of this backend
root : builtins.str, optional
root of this backend
token : builtins.str, optional
token of this backend
username : builtins.str, optional
username of this backend
Returns
-------
Operator
The new `Operator` for `webdav` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Webhdfs, typing.Literal["webhdfs"]],
/,
*,
atomic_write_dir: builtins.str = ...,
delegation: builtins.str = ...,
disable_list_batch: builtins.bool = ...,
endpoint: builtins.str = ...,
root: builtins.str = ...,
user_name: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `webhdfs` service.
Parameters
----------
atomic_write_dir : builtins.str, optional
atomic_write_dir of this backend
delegation : builtins.str, optional
Delegation token for webhdfs.
disable_list_batch : builtins.bool, optional
Disable batch listing
endpoint : builtins.str, optional
Endpoint for webhdfs.
root : builtins.str, optional
Root for webhdfs.
user_name : builtins.str, optional
Name of the user for webhdfs.
Returns
-------
Operator
The new `Operator` for `webhdfs` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class Operator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.YandexDisk, typing.Literal["yandex-disk"]],
/,
*,
access_token: builtins.str,
root: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `Operator` for `yandex-disk` service.
Parameters
----------
access_token : builtins.str
yandex disk oauth access_token.
root : builtins.str, optional
root of this backend.
All operations will happen under this root.
Returns
-------
Operator
The new `Operator` for `yandex-disk` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
class AsyncOperator:
@overload
def __new__(cls,
scheme: builtins.str,
/,
**kwargs: builtins.str,
) -> typing_extensions.Self: ...
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.AliyunDrive, typing.Literal["aliyun-drive"]],
/,
*,
access_token: builtins.str = ...,
client_id: builtins.str = ...,
client_secret: builtins.str = ...,
drive_type: builtins.str,
refresh_token: builtins.str = ...,
root: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `aliyun-drive` service.
Parameters
----------
access_token : builtins.str, optional
The access_token of this backend.
Solution for client-only purpose.
#4733 Required if no client_id, client_secret and
refresh_token are provided.
client_id : builtins.str, optional
The client_id of this backend.
Required if no access_token is provided.
client_secret : builtins.str, optional
The client_secret of this backend.
Required if no access_token is provided.
drive_type : builtins.str
The drive_type of this backend.
All operations will happen under this type of drive.
Available values are `default`, `backup` and
`resource`.
Fallback to default if not set or no other drives
can be found.
refresh_token : builtins.str, optional
The refresh_token of this backend.
Required if no access_token is provided.
root : builtins.str, optional
The Root of this backend.
All operations will happen under this root.
Default to `/` if not set.
Returns
-------
AsyncOperator
The new `AsyncOperator` for `aliyun-drive` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Alluxio, typing.Literal["alluxio"]],
/,
*,
endpoint: builtins.str = ...,
root: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `alluxio` service.
Parameters
----------
endpoint : builtins.str, optional
endpoint of this backend.
Endpoint must be full uri, mostly like
`http://127.0.0.1:39999`.
root : builtins.str, optional
root of this backend.
All operations will happen under this root.
default to `/` if not set.
Returns
-------
AsyncOperator
The new `AsyncOperator` for `alluxio` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Azblob, typing.Literal["azblob"]],
/,
*,
account_key: builtins.str = ...,
account_name: builtins.str = ...,
batch_max_operations: builtins.int = ...,
container: builtins.str,
encryption_algorithm: builtins.str = ...,
encryption_key: builtins.str = ...,
encryption_key_sha256: builtins.str = ...,
endpoint: builtins.str = ...,
root: builtins.str = ...,
sas_token: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `azblob` service.
Parameters
----------
account_key : builtins.str, optional
The account key of Azblob service backend.
account_name : builtins.str, optional
The account name of Azblob service backend.
batch_max_operations : builtins.int, optional
The maximum batch operations of Azblob service
backend.
container : builtins.str
The container name of Azblob service backend.
encryption_algorithm : builtins.str, optional
The encryption algorithm of Azblob service backend.
encryption_key : builtins.str, optional
The encryption key of Azblob service backend.
encryption_key_sha256 : builtins.str, optional
The encryption key sha256 of Azblob service backend.
endpoint : builtins.str, optional
The endpoint of Azblob service backend.
Endpoint must be full uri, e.g.
- Azblob:
`https://accountname.blob.core.windows.net` -
Azurite: `http://127.0.0.1:10000/devstoreaccount1`
root : builtins.str, optional
The root of Azblob service backend.
All operations will happen under this root.
sas_token : builtins.str, optional
The sas token of Azblob service backend.
Returns
-------
AsyncOperator
The new `AsyncOperator` for `azblob` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Azdls, typing.Literal["azdls"]],
/,
*,
account_key: builtins.str = ...,
account_name: builtins.str = ...,
authority_host: builtins.str = ...,
client_id: builtins.str = ...,
client_secret: builtins.str = ...,
endpoint: builtins.str = ...,
filesystem: builtins.str,
root: builtins.str = ...,
sas_token: builtins.str = ...,
tenant_id: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `azdls` service.
Parameters
----------
account_key : builtins.str, optional
Account key of this backend.
- required for shared_key authentication
account_name : builtins.str, optional
Account name of this backend.
authority_host : builtins.str, optional
authority_host The authority host of the service
principal.
- required for client_credentials authentication -
default value: `https://login.microsoftonline.com`
client_id : builtins.str, optional
client_id The client id of the service principal.
- required for client_credentials authentication
client_secret : builtins.str, optional
client_secret The client secret of the service
principal.
- required for client_credentials authentication
endpoint : builtins.str, optional
Endpoint of this backend.
filesystem : builtins.str
Filesystem name of this backend.
root : builtins.str, optional
Root of this backend.
sas_token : builtins.str, optional
sas_token The shared access signature token.
- required for sas authentication
tenant_id : builtins.str, optional
tenant_id The tenant id of the service principal.
- required for client_credentials authentication
Returns
-------
AsyncOperator
The new `AsyncOperator` for `azdls` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Azfile, typing.Literal["azfile"]],
/,
*,
account_key: builtins.str = ...,
account_name: builtins.str = ...,
endpoint: builtins.str = ...,
root: builtins.str = ...,
sas_token: builtins.str = ...,
share_name: builtins.str,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `azfile` service.
Parameters
----------
account_key : builtins.str, optional
The account key for azfile.
account_name : builtins.str, optional
The account name for azfile.
endpoint : builtins.str, optional
The endpoint for azfile.
root : builtins.str, optional
The root path for azfile.
sas_token : builtins.str, optional
The sas token for azfile.
share_name : builtins.str
The share name for azfile.
Returns
-------
AsyncOperator
The new `AsyncOperator` for `azfile` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.B2, typing.Literal["b2"]],
/,
*,
application_key: builtins.str = ...,
application_key_id: builtins.str = ...,
bucket: builtins.str,
bucket_id: builtins.str,
root: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `b2` service.
Parameters
----------
application_key : builtins.str, optional
applicationKey of this backend.
- If application_key is set, we will take user's
input first.
- If not, we will try to load it from environment.
application_key_id : builtins.str, optional
keyID of this backend.
- If application_key_id is set, we will take user's
input first.
- If not, we will try to load it from environment.
bucket : builtins.str
bucket of this backend.
required.
bucket_id : builtins.str
bucket id of this backend.
required.
root : builtins.str, optional
root of this backend.
All operations will happen under this root.
Returns
-------
AsyncOperator
The new `AsyncOperator` for `b2` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Cacache, typing.Literal["cacache"]],
/,
*,
datadir: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `cacache` service.
Parameters
----------
datadir : builtins.str, optional
That path to the cacache data directory.
Returns
-------
AsyncOperator
The new `AsyncOperator` for `cacache` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Cos, typing.Literal["cos"]],
/,
*,
bucket: builtins.str = ...,
disable_config_load: builtins.bool = ...,
enable_versioning: builtins.bool = ...,
endpoint: builtins.str = ...,
root: builtins.str = ...,
secret_id: builtins.str = ...,
secret_key: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `cos` service.
Parameters
----------
bucket : builtins.str, optional
Bucket of this backend.
disable_config_load : builtins.bool, optional
Disable config load so that opendal will not load
config from
enable_versioning : builtins.bool, optional
is bucket versioning enabled for this bucket
endpoint : builtins.str, optional
Endpoint of this backend.
root : builtins.str, optional
Root of this backend.
secret_id : builtins.str, optional
Secret ID of this backend.
secret_key : builtins.str, optional
Secret key of this backend.
Returns
-------
AsyncOperator
The new `AsyncOperator` for `cos` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Dashmap, typing.Literal["dashmap"]],
/,
*,
root: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `dashmap` service.
Parameters
----------
root : builtins.str, optional
root path of this backend
Returns
-------
AsyncOperator
The new `AsyncOperator` for `dashmap` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Dropbox, typing.Literal["dropbox"]],
/,
*,
access_token: builtins.str = ...,
client_id: builtins.str = ...,
client_secret: builtins.str = ...,
refresh_token: builtins.str = ...,
root: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `dropbox` service.
Parameters
----------
access_token : builtins.str, optional
access token for dropbox.
client_id : builtins.str, optional
client_id for dropbox.
client_secret : builtins.str, optional
client_secret for dropbox.
refresh_token : builtins.str, optional
refresh_token for dropbox.
root : builtins.str, optional
root path for dropbox.
Returns
-------
AsyncOperator
The new `AsyncOperator` for `dropbox` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Fs, typing.Literal["fs"]],
/,
*,
atomic_write_dir: builtins.str = ...,
root: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `fs` service.
Parameters
----------
atomic_write_dir : builtins.str, optional
tmp dir for atomic write
root : builtins.str, optional
root dir for backend
Returns
-------
AsyncOperator
The new `AsyncOperator` for `fs` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Ftp, typing.Literal["ftp"]],
/,
*,
endpoint: builtins.str = ...,
password: builtins.str = ...,
root: builtins.str = ...,
user: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `ftp` service.
Parameters
----------
endpoint : builtins.str, optional
endpoint of this backend
password : builtins.str, optional
password of this backend
root : builtins.str, optional
root of this backend
user : builtins.str, optional
user of this backend
Returns
-------
AsyncOperator
The new `AsyncOperator` for `ftp` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Gcs, typing.Literal["gcs"]],
/,
*,
allow_anonymous: builtins.bool = ...,
bucket: builtins.str,
credential: builtins.str = ...,
credential_path: builtins.str = ...,
default_storage_class: builtins.str = ...,
disable_config_load: builtins.bool = ...,
disable_vm_metadata: builtins.bool = ...,
endpoint: builtins.str = ...,
predefined_acl: builtins.str = ...,
root: builtins.str = ...,
scope: builtins.str = ...,
service_account: builtins.str = ...,
token: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `gcs` service.
Parameters
----------
allow_anonymous : builtins.bool, optional
Allow opendal to send requests without signing when
credentials are not loaded.
bucket : builtins.str
bucket name
credential : builtins.str, optional
Credentials string for GCS service OAuth2
authentication.
credential_path : builtins.str, optional
Local path to credentials file for GCS service
OAuth2 authentication.
default_storage_class : builtins.str, optional
The default storage class used by gcs.
disable_config_load : builtins.bool, optional
Disable loading configuration from the environment.
disable_vm_metadata : builtins.bool, optional
Disable attempting to load credentials from the GCE
metadata server when running within Google Cloud.
endpoint : builtins.str, optional
endpoint URI of GCS service, default is
`https://storage.googleapis.com`
predefined_acl : builtins.str, optional
The predefined acl for GCS.
root : builtins.str, optional
root URI, all operations happens under `root`
scope : builtins.str, optional
Scope for gcs.
service_account : builtins.str, optional
Service Account for gcs.
token : builtins.str, optional
A Google Cloud OAuth2 token.
Takes precedence over `credential` and
`credential_path`.
Returns
-------
AsyncOperator
The new `AsyncOperator` for `gcs` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Gdrive, typing.Literal["gdrive"]],
/,
*,
access_token: builtins.str = ...,
client_id: builtins.str = ...,
client_secret: builtins.str = ...,
refresh_token: builtins.str = ...,
root: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `gdrive` service.
Parameters
----------
access_token : builtins.str, optional
Access token for gdrive.
client_id : builtins.str, optional
Client id for gdrive.
client_secret : builtins.str, optional
Client secret for gdrive.
refresh_token : builtins.str, optional
Refresh token for gdrive.
root : builtins.str, optional
The root for gdrive
Returns
-------
AsyncOperator
The new `AsyncOperator` for `gdrive` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Ghac, typing.Literal["ghac"]],
/,
*,
endpoint: builtins.str = ...,
root: builtins.str = ...,
runtime_token: builtins.str = ...,
version: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `ghac` service.
Parameters
----------
endpoint : builtins.str, optional
The endpoint for ghac service.
root : builtins.str, optional
The root path for ghac.
runtime_token : builtins.str, optional
The runtime token for ghac service.
version : builtins.str, optional
The version that used by cache.
Returns
-------
AsyncOperator
The new `AsyncOperator` for `ghac` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Gridfs, typing.Literal["gridfs"]],
/,
*,
bucket: builtins.str = ...,
chunk_size: builtins.int = ...,
connection_string: builtins.str = ...,
database: builtins.str = ...,
root: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `gridfs` service.
Parameters
----------
bucket : builtins.str, optional
The bucket name of the MongoDB GridFs service to
read/write.
chunk_size : builtins.int, optional
The chunk size of the MongoDB GridFs service used to
break the user file into chunks.
connection_string : builtins.str, optional
The connection string of the MongoDB service.
database : builtins.str, optional
The database name of the MongoDB GridFs service to
read/write.
root : builtins.str, optional
The working directory, all operations will be
performed under it.
Returns
-------
AsyncOperator
The new `AsyncOperator` for `gridfs` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.HdfsNative, typing.Literal["hdfs-native"]],
/,
*,
enable_append: builtins.bool = ...,
name_node: builtins.str = ...,
root: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `hdfs-native` service.
Parameters
----------
enable_append : builtins.bool, optional
enable the append capacity
name_node : builtins.str, optional
name_node of this backend
root : builtins.str, optional
work dir of this backend
Returns
-------
AsyncOperator
The new `AsyncOperator` for `hdfs-native` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Http, typing.Literal["http"]],
/,
*,
endpoint: builtins.str = ...,
password: builtins.str = ...,
root: builtins.str = ...,
token: builtins.str = ...,
username: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `http` service.
Parameters
----------
endpoint : builtins.str, optional
endpoint of this backend
password : builtins.str, optional
password of this backend
root : builtins.str, optional
root of this backend
token : builtins.str, optional
token of this backend
username : builtins.str, optional
username of this backend
Returns
-------
AsyncOperator
The new `AsyncOperator` for `http` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Huggingface, typing.Literal["huggingface"]],
/,
*,
endpoint: builtins.str = ...,
repo_id: builtins.str = ...,
repo_type: builtins.str = ...,
revision: builtins.str = ...,
root: builtins.str = ...,
token: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `huggingface` service.
Parameters
----------
endpoint : builtins.str, optional
Endpoint of the Huggingface Hub.
Default is "https://huggingface.co".
repo_id : builtins.str, optional
Repo id of this backend.
This is required.
repo_type : builtins.str, optional
Repo type of this backend.
Default is model.
Available values: - model - dataset - datasets
(alias for dataset)
revision : builtins.str, optional
Revision of this backend.
Default is main.
root : builtins.str, optional
Root of this backend.
Can be "/path/to/dir".
Default is "/".
token : builtins.str, optional
Token of this backend.
This is optional.
Returns
-------
AsyncOperator
The new `AsyncOperator` for `huggingface` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Ipfs, typing.Literal["ipfs"]],
/,
*,
endpoint: builtins.str = ...,
root: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `ipfs` service.
Parameters
----------
endpoint : builtins.str, optional
IPFS gateway endpoint.
root : builtins.str, optional
IPFS root.
Returns
-------
AsyncOperator
The new `AsyncOperator` for `ipfs` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Ipmfs, typing.Literal["ipmfs"]],
/,
*,
endpoint: builtins.str = ...,
root: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `ipmfs` service.
Parameters
----------
endpoint : builtins.str, optional
Endpoint for ipfs.
root : builtins.str, optional
Root for ipfs.
Returns
-------
AsyncOperator
The new `AsyncOperator` for `ipmfs` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Koofr, typing.Literal["koofr"]],
/,
*,
email: builtins.str,
endpoint: builtins.str,
password: builtins.str = ...,
root: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `koofr` service.
Parameters
----------
email : builtins.str
Koofr email.
endpoint : builtins.str
Koofr endpoint.
password : builtins.str, optional
password of this backend.
(Must be the application password)
root : builtins.str, optional
root of this backend.
All operations will happen under this root.
Returns
-------
AsyncOperator
The new `AsyncOperator` for `koofr` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Memcached, typing.Literal["memcached"]],
/,
*,
connection_pool_max_size: builtins.int = ...,
default_ttl: typing.Any = ...,
endpoint: builtins.str = ...,
password: builtins.str = ...,
root: builtins.str = ...,
username: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `memcached` service.
Parameters
----------
connection_pool_max_size : builtins.int, optional
The maximum number of connections allowed.
default is 10
default_ttl : typing.Any, optional
The default ttl for put operations..
a human readable duration string see
https://docs.rs/humantime/latest/humantime/fn.parse_duration.html
for more details
endpoint : builtins.str, optional
network address of the memcached service.
For example: "tcp://localhost:11211"
password : builtins.str, optional
Memcached password, optional.
root : builtins.str, optional
the working directory of the service.
Can be "/path/to/dir" default is "/"
username : builtins.str, optional
Memcached username, optional.
Returns
-------
AsyncOperator
The new `AsyncOperator` for `memcached` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Memory, typing.Literal["memory"]],
/,
*,
root: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `memory` service.
Parameters
----------
root : builtins.str, optional
root of the backend.
Returns
-------
AsyncOperator
The new `AsyncOperator` for `memory` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.MiniMoka, typing.Literal["mini-moka"]],
/,
*,
max_capacity: builtins.int = ...,
root: builtins.str = ...,
time_to_idle: builtins.str = ...,
time_to_live: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `mini-moka` service.
Parameters
----------
max_capacity : builtins.int, optional
Sets the max capacity of the cache.
Refer to
[`mini-moka::sync::CacheBuilder::max_capacity`](https://docs.rs/mini-moka/latest/mini_moka/sync/struct.CacheBuilder.html#method.max_capacity)
root : builtins.str, optional
root path of this backend
time_to_idle : builtins.str, optional
Sets the time to idle of the cache.
Refer to
[`mini-moka::sync::CacheBuilder::time_to_idle`](https://docs.rs/mini-moka/latest/mini_moka/sync/struct.CacheBuilder.html#method.time_to_idle)
time_to_live : builtins.str, optional
Sets the time to live of the cache.
Refer to
[`mini-moka::sync::CacheBuilder::time_to_live`](https://docs.rs/mini-moka/latest/mini_moka/sync/struct.CacheBuilder.html#method.time_to_live)
Returns
-------
AsyncOperator
The new `AsyncOperator` for `mini-moka` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Moka, typing.Literal["moka"]],
/,
*,
max_capacity: builtins.int = ...,
name: builtins.str = ...,
root: builtins.str = ...,
time_to_idle: builtins.str = ...,
time_to_live: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `moka` service.
Parameters
----------
max_capacity : builtins.int, optional
Sets the max capacity of the cache.
Refer to
[`moka::future::CacheBuilder::max_capacity`](https://docs.rs/moka/latest/moka/future/struct.CacheBuilder.html#method.max_capacity)
name : builtins.str, optional
Name for this cache instance.
root : builtins.str, optional
root path of this backend
time_to_idle : builtins.str, optional
Sets the time to idle of the cache.
Refer to
[`moka::future::CacheBuilder::time_to_idle`](https://docs.rs/moka/latest/moka/future/struct.CacheBuilder.html#method.time_to_idle)
time_to_live : builtins.str, optional
Sets the time to live of the cache.
Refer to
[`moka::future::CacheBuilder::time_to_live`](https://docs.rs/moka/latest/moka/future/struct.CacheBuilder.html#method.time_to_live)
Returns
-------
AsyncOperator
The new `AsyncOperator` for `moka` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Mongodb, typing.Literal["mongodb"]],
/,
*,
collection: builtins.str = ...,
connection_string: builtins.str = ...,
database: builtins.str = ...,
key_field: builtins.str = ...,
root: builtins.str = ...,
value_field: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `mongodb` service.
Parameters
----------
collection : builtins.str, optional
collection of this backend
connection_string : builtins.str, optional
connection string of this backend
database : builtins.str, optional
database of this backend
key_field : builtins.str, optional
key field of this backend
root : builtins.str, optional
root of this backend
value_field : builtins.str, optional
value field of this backend
Returns
-------
AsyncOperator
The new `AsyncOperator` for `mongodb` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Mysql, typing.Literal["mysql"]],
/,
*,
connection_string: builtins.str = ...,
key_field: builtins.str = ...,
root: builtins.str = ...,
table: builtins.str = ...,
value_field: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `mysql` service.
Parameters
----------
connection_string : builtins.str, optional
This connection string is used to connect to the
mysql service.
There are url based formats.
The format of connect string resembles the url
format of the mysql client.
The format is:
`[scheme://][user[:[password]]@]host[:port][/schema][?attribute1=value1&attribute2=value2...`
- `mysql://user@localhost` -
`mysql://user:password@localhost` -
`mysql://user:password@localhost:3306` -
`mysql://user:password@localhost:3306/db` For more
information, please refer to
<https://docs.rs/sqlx/latest/sqlx/mysql/struct.MySqlConnectOptions.html>.
key_field : builtins.str, optional
The key field name for mysql.
root : builtins.str, optional
The root for mysql.
table : builtins.str, optional
The table name for mysql.
value_field : builtins.str, optional
The value field name for mysql.
Returns
-------
AsyncOperator
The new `AsyncOperator` for `mysql` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Obs, typing.Literal["obs"]],
/,
*,
access_key_id: builtins.str = ...,
bucket: builtins.str = ...,
enable_versioning: builtins.bool = ...,
endpoint: builtins.str = ...,
root: builtins.str = ...,
secret_access_key: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `obs` service.
Parameters
----------
access_key_id : builtins.str, optional
Access key id for obs.
bucket : builtins.str, optional
Bucket for obs.
enable_versioning : builtins.bool, optional
Is bucket versioning enabled for this bucket
endpoint : builtins.str, optional
Endpoint for obs.
root : builtins.str, optional
Root for obs.
secret_access_key : builtins.str, optional
Secret access key for obs.
Returns
-------
AsyncOperator
The new `AsyncOperator` for `obs` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Onedrive, typing.Literal["onedrive"]],
/,
*,
access_token: builtins.str = ...,
client_id: builtins.str = ...,
client_secret: builtins.str = ...,
enable_versioning: builtins.bool = ...,
refresh_token: builtins.str = ...,
root: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `onedrive` service.
Parameters
----------
access_token : builtins.str, optional
Microsoft Graph API (also OneDrive API) access token
client_id : builtins.str, optional
Microsoft Graph API Application (client) ID that is
in the Azure's app registration portal
client_secret : builtins.str, optional
Microsoft Graph API Application client secret that
is in the Azure's app registration portal
enable_versioning : builtins.bool, optional
Enabling version support
refresh_token : builtins.str, optional
Microsoft Graph API (also OneDrive API) refresh
token
root : builtins.str, optional
The root path for the OneDrive service for the file
access
Returns
-------
AsyncOperator
The new `AsyncOperator` for `onedrive` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Oss, typing.Literal["oss"]],
/,
*,
access_key_id: builtins.str = ...,
access_key_secret: builtins.str = ...,
addressing_style: builtins.str = ...,
allow_anonymous: builtins.bool = ...,
batch_max_operations: builtins.int = ...,
bucket: builtins.str,
delete_max_size: builtins.int = ...,
enable_versioning: builtins.bool = ...,
endpoint: builtins.str = ...,
oidc_provider_arn: builtins.str = ...,
oidc_token_file: builtins.str = ...,
presign_addressing_style: builtins.str = ...,
presign_endpoint: builtins.str = ...,
role_arn: builtins.str = ...,
role_session_name: builtins.str = ...,
root: builtins.str = ...,
security_token: builtins.str = ...,
server_side_encryption: builtins.str = ...,
server_side_encryption_key_id: builtins.str = ...,
sts_endpoint: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `oss` service.
Parameters
----------
access_key_id : builtins.str, optional
Access key id for oss.
- this field if it's `is_some` - env value:
[`ALIBABA_CLOUD_ACCESS_KEY_ID`]
access_key_secret : builtins.str, optional
Access key secret for oss.
- this field if it's `is_some` - env value:
[`ALIBABA_CLOUD_ACCESS_KEY_SECRET`]
addressing_style : builtins.str, optional
Addressing style for oss.
allow_anonymous : builtins.bool, optional
Allow anonymous for oss.
batch_max_operations : builtins.int, optional
The size of max batch operations.
bucket : builtins.str
Bucket for oss.
delete_max_size : builtins.int, optional
The size of max delete operations.
enable_versioning : builtins.bool, optional
is bucket versioning enabled for this bucket
endpoint : builtins.str, optional
Endpoint for oss.
oidc_provider_arn : builtins.str, optional
`oidc_provider_arn` will be loaded from - this field
if it's `is_some` - env value:
[`ALIBABA_CLOUD_OIDC_PROVIDER_ARN`]
oidc_token_file : builtins.str, optional
`oidc_token_file` will be loaded from - this field
if it's `is_some` - env value:
[`ALIBABA_CLOUD_OIDC_TOKEN_FILE`]
presign_addressing_style : builtins.str, optional
Pre sign addressing style for oss.
presign_endpoint : builtins.str, optional
Presign endpoint for oss.
role_arn : builtins.str, optional
If `role_arn` is set, we will use already known
config as source credential to assume role with
`role_arn`.
- this field if it's `is_some` - env value:
[`ALIBABA_CLOUD_ROLE_ARN`]
role_session_name : builtins.str, optional
role_session_name for this backend.
root : builtins.str, optional
Root for oss.
security_token : builtins.str, optional
`security_token` will be loaded from - this field if
it's `is_some` - env value:
[`ALIBABA_CLOUD_SECURITY_TOKEN`]
server_side_encryption : builtins.str, optional
Server side encryption for oss.
server_side_encryption_key_id : builtins.str, optional
Server side encryption key id for oss.
sts_endpoint : builtins.str, optional
`sts_endpoint` will be loaded from - this field if
it's `is_some` - env value:
[`ALIBABA_CLOUD_STS_ENDPOINT`]
Returns
-------
AsyncOperator
The new `AsyncOperator` for `oss` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Persy, typing.Literal["persy"]],
/,
*,
datafile: builtins.str = ...,
index: builtins.str = ...,
segment: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `persy` service.
Parameters
----------
datafile : builtins.str, optional
That path to the persy data file.
The directory in the path must already exist.
index : builtins.str, optional
That name of the persy index.
segment : builtins.str, optional
That name of the persy segment.
Returns
-------
AsyncOperator
The new `AsyncOperator` for `persy` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Postgresql, typing.Literal["postgresql"]],
/,
*,
connection_string: builtins.str = ...,
key_field: builtins.str = ...,
root: builtins.str = ...,
table: builtins.str = ...,
value_field: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `postgresql` service.
Parameters
----------
connection_string : builtins.str, optional
The URL should be with a scheme of either
`postgres://` or `postgresql://`.
- `postgresql://user@localhost` -
`postgresql://user:password@%2Fvar%2Flib%2Fpostgresql/mydb?connect_timeout=10`
-
`postgresql://user@host1:1234,host2,host3:5678?target_session_attrs=read-write`
-
`postgresql:///mydb?user=user&host=/var/lib/postgresql`
For more information, please visit
<https://docs.rs/sqlx/latest/sqlx/postgres/struct.PgConnectOptions.html>.
key_field : builtins.str, optional
the key field of postgresql
root : builtins.str, optional
Root of this backend.
All operations will happen under this root.
Default to `/` if not set.
table : builtins.str, optional
the table of postgresql
value_field : builtins.str, optional
the value field of postgresql
Returns
-------
AsyncOperator
The new `AsyncOperator` for `postgresql` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Redb, typing.Literal["redb"]],
/,
*,
datadir: builtins.str = ...,
root: builtins.str = ...,
table: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `redb` service.
Parameters
----------
datadir : builtins.str, optional
path to the redb data directory.
root : builtins.str, optional
The root for redb.
table : builtins.str, optional
The table name for redb.
Returns
-------
AsyncOperator
The new `AsyncOperator` for `redb` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Redis, typing.Literal["redis"]],
/,
*,
cluster_endpoints: builtins.str = ...,
connection_pool_max_size: builtins.int = ...,
db: builtins.int,
default_ttl: typing.Any = ...,
endpoint: builtins.str = ...,
password: builtins.str = ...,
root: builtins.str = ...,
username: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `redis` service.
Parameters
----------
cluster_endpoints : builtins.str, optional
network address of the Redis cluster service.
Can be
"tcp://127.0.0.1:6379,tcp://127.0.0.1:6380,tcp://127.0.0.1:6381",
e.g.
default is None
connection_pool_max_size : builtins.int, optional
The maximum number of connections allowed.
default is 10
db : builtins.int
the number of DBs redis can take is unlimited
default is db 0
default_ttl : typing.Any, optional
The default ttl for put operations..
a human readable duration string see
https://docs.rs/humantime/latest/humantime/fn.parse_duration.html
for more details
endpoint : builtins.str, optional
network address of the Redis service.
Can be "tcp://127.0.0.1:6379", e.g.
default is "tcp://127.0.0.1:6379"
password : builtins.str, optional
the password for authentication default is None
root : builtins.str, optional
the working directory of the Redis service.
Can be "/path/to/dir" default is "/"
username : builtins.str, optional
the username to connect redis service.
default is None
Returns
-------
AsyncOperator
The new `AsyncOperator` for `redis` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.S3, typing.Literal["s3"]],
/,
*,
access_key_id: builtins.str = ...,
allow_anonymous: builtins.bool = ...,
batch_max_operations: builtins.int = ...,
bucket: builtins.str,
checksum_algorithm: builtins.str = ...,
default_storage_class: builtins.str = ...,
delete_max_size: builtins.int = ...,
disable_config_load: builtins.bool = ...,
disable_ec2_metadata: builtins.bool = ...,
disable_list_objects_v2: builtins.bool = ...,
disable_stat_with_override: builtins.bool = ...,
disable_write_with_if_match: builtins.bool = ...,
enable_request_payer: builtins.bool = ...,
enable_versioning: builtins.bool = ...,
enable_virtual_host_style: builtins.bool = ...,
enable_write_with_append: builtins.bool = ...,
endpoint: builtins.str = ...,
external_id: builtins.str = ...,
region: builtins.str = ...,
role_arn: builtins.str = ...,
role_session_name: builtins.str = ...,
root: builtins.str = ...,
secret_access_key: builtins.str = ...,
server_side_encryption: builtins.str = ...,
server_side_encryption_aws_kms_key_id: builtins.str = ...,
server_side_encryption_customer_algorithm: builtins.str = ...,
server_side_encryption_customer_key: builtins.str = ...,
server_side_encryption_customer_key_md5: builtins.str = ...,
session_token: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `s3` service.
Parameters
----------
access_key_id : builtins.str, optional
access_key_id of this backend.
- If access_key_id is set, we will take user's input
first.
- If not, we will try to load it from environment.
allow_anonymous : builtins.bool, optional
Allow anonymous will allow opendal to send request
without signing when credential is not loaded.
batch_max_operations : builtins.int, optional
Set maximum batch operations of this backend.
Some compatible services have a limit on the number
of operations in a batch request.
For example, R2 could return `Internal Error` while
batch delete 1000 files.
Please tune this value based on services' document.
bucket : builtins.str
bucket name of this backend.
required.
checksum_algorithm : builtins.str, optional
Checksum Algorithm to use when sending checksums in
HTTP headers.
This is necessary when writing to AWS S3 Buckets
with Object Lock enabled for example.
Available options: - "crc32c" - "md5"
default_storage_class : builtins.str, optional
default storage_class for this backend.
Available values: - `DEEP_ARCHIVE` - `GLACIER` -
`GLACIER_IR` - `INTELLIGENT_TIERING` - `ONEZONE_IA`
- `EXPRESS_ONEZONE` - `OUTPOSTS` -
`REDUCED_REDUNDANCY` - `STANDARD` - `STANDARD_IA` S3
compatible services don't support all of them
delete_max_size : builtins.int, optional
Set the maximum delete size of this backend.
Some compatible services have a limit on the number
of operations in a batch request.
For example, R2 could return `Internal Error` while
batch delete 1000 files.
Please tune this value based on services' document.
disable_config_load : builtins.bool, optional
Disable config load so that opendal will not load
config from environment.
For examples: - envs like `AWS_ACCESS_KEY_ID` -
files like `~/.aws/config`
disable_ec2_metadata : builtins.bool, optional
Disable load credential from ec2 metadata.
This option is used to disable the default behavior
of opendal to load credential from ec2 metadata,
a.k.a., IMDSv2
disable_list_objects_v2 : builtins.bool, optional
OpenDAL uses List Objects V2 by default to list
objects.
However, some legacy services do not yet support V2.
This option allows users to switch back to the older
List Objects V1.
disable_stat_with_override : builtins.bool, optional
Disable stat with override so that opendal will not
send stat request with override queries.
For example, R2 doesn't support stat with
`response_content_type` query.
disable_write_with_if_match : builtins.bool, optional
Disable write with if match so that opendal will not
send write request with if match headers.
For example, Ceph RADOS S3 doesn't support write
with if matched.
enable_request_payer : builtins.bool, optional
Indicates whether the client agrees to pay for the
requests made to the S3 bucket.
enable_versioning : builtins.bool, optional
is bucket versioning enabled for this bucket
enable_virtual_host_style : builtins.bool, optional
Enable virtual host style so that opendal will send
API requests in virtual host style instead of path
style.
- By default, opendal will send API to
`https://s3.us-east-1.amazonaws.com/bucket_name` -
Enabled, opendal will send API to
`https://bucket_name.s3.us-east-1.amazonaws.com`
enable_write_with_append : builtins.bool, optional
Enable write with append so that opendal will send
write request with append headers.
endpoint : builtins.str, optional
endpoint of this backend.
Endpoint must be full uri, e.g.
- AWS S3: `https://s3.amazonaws.com` or
`https://s3.{region}.amazonaws.com` - Cloudflare R2:
`https://<ACCOUNT_ID>.r2.cloudflarestorage.com` -
Aliyun OSS: `https://{region}.aliyuncs.com` -
Tencent COS: `https://cos.{region}.myqcloud.com` -
Minio: `http://127.0.0.1:9000` If user inputs
endpoint without scheme like "s3.amazonaws.com", we
will prepend "https://" before it.
- If endpoint is set, we will take user's input
first.
- If not, we will try to load it from environment.
- If still not set, default to
`https://s3.amazonaws.com`.
external_id : builtins.str, optional
external_id for this backend.
region : builtins.str, optional
Region represent the signing region of this
endpoint.
This is required if you are using the default AWS S3
endpoint.
If using a custom endpoint, - If region is set, we
will take user's input first.
- If not, we will try to load it from environment.
role_arn : builtins.str, optional
role_arn for this backend.
If `role_arn` is set, we will use already known
config as source credential to assume role with
`role_arn`.
role_session_name : builtins.str, optional
role_session_name for this backend.
root : builtins.str, optional
root of this backend.
All operations will happen under this root.
default to `/` if not set.
secret_access_key : builtins.str, optional
secret_access_key of this backend.
- If secret_access_key is set, we will take user's
input first.
- If not, we will try to load it from environment.
server_side_encryption : builtins.str, optional
server_side_encryption for this backend.
Available values: `AES256`, `aws:kms`.
server_side_encryption_aws_kms_key_id : builtins.str, optional
server_side_encryption_aws_kms_key_id for this
backend - If `server_side_encryption` set to
`aws:kms`, and
`server_side_encryption_aws_kms_key_id` is not set,
S3 will use aws managed kms key to encrypt data.
- If `server_side_encryption` set to `aws:kms`, and
`server_side_encryption_aws_kms_key_id` is a valid
kms key id, S3 will use the provided kms key to
encrypt data.
- If the `server_side_encryption_aws_kms_key_id` is
invalid or not found, an error will be returned.
- If `server_side_encryption` is not `aws:kms`,
setting `server_side_encryption_aws_kms_key_id` is a
noop.
server_side_encryption_customer_algorithm : builtins.str, optional
server_side_encryption_customer_algorithm for this
backend.
Available values: `AES256`.
server_side_encryption_customer_key : builtins.str, optional
server_side_encryption_customer_key for this
backend.
Value: BASE64-encoded key that matches algorithm
specified in
`server_side_encryption_customer_algorithm`.
server_side_encryption_customer_key_md5 : builtins.str, optional
Set server_side_encryption_customer_key_md5 for this
backend.
Value: MD5 digest of key specified in
`server_side_encryption_customer_key`.
session_token : builtins.str, optional
session_token (aka, security token) of this backend.
This token will expire after sometime, it's
recommended to set session_token by hand.
Returns
-------
AsyncOperator
The new `AsyncOperator` for `s3` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Seafile, typing.Literal["seafile"]],
/,
*,
endpoint: builtins.str = ...,
password: builtins.str = ...,
repo_name: builtins.str,
root: builtins.str = ...,
username: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `seafile` service.
Parameters
----------
endpoint : builtins.str, optional
endpoint address of this backend.
password : builtins.str, optional
password of this backend.
repo_name : builtins.str
repo_name of this backend.
required.
root : builtins.str, optional
root of this backend.
All operations will happen under this root.
username : builtins.str, optional
username of this backend.
Returns
-------
AsyncOperator
The new `AsyncOperator` for `seafile` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Sftp, typing.Literal["sftp"]],
/,
*,
enable_copy: builtins.bool = ...,
endpoint: builtins.str = ...,
key: builtins.str = ...,
known_hosts_strategy: builtins.str = ...,
root: builtins.str = ...,
user: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `sftp` service.
Parameters
----------
enable_copy : builtins.bool, optional
enable_copy of this backend
endpoint : builtins.str, optional
endpoint of this backend
key : builtins.str, optional
key of this backend
known_hosts_strategy : builtins.str, optional
known_hosts_strategy of this backend
root : builtins.str, optional
root of this backend
user : builtins.str, optional
user of this backend
Returns
-------
AsyncOperator
The new `AsyncOperator` for `sftp` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Sled, typing.Literal["sled"]],
/,
*,
datadir: builtins.str = ...,
root: builtins.str = ...,
tree: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `sled` service.
Parameters
----------
datadir : builtins.str, optional
That path to the sled data directory.
root : builtins.str, optional
The root for sled.
tree : builtins.str, optional
The tree for sled.
Returns
-------
AsyncOperator
The new `AsyncOperator` for `sled` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Sqlite, typing.Literal["sqlite"]],
/,
*,
connection_string: builtins.str = ...,
key_field: builtins.str = ...,
root: builtins.str = ...,
table: builtins.str = ...,
value_field: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `sqlite` service.
Parameters
----------
connection_string : builtins.str, optional
Set the connection_string of the sqlite service.
This connection string is used to connect to the
sqlite service.
The format of connect string resembles the url
format of the sqlite client: - `sqlite::memory:` -
`sqlite:data.db` - `sqlite://data.db` For more
information, please visit
<https://docs.rs/sqlx/latest/sqlx/sqlite/struct.SqliteConnectOptions.html>.
key_field : builtins.str, optional
Set the key field name of the sqlite service to
read/write.
Default to `key` if not specified.
root : builtins.str, optional
set the working directory, all operations will be
performed under it.
default: "/"
table : builtins.str, optional
Set the table name of the sqlite service to
read/write.
value_field : builtins.str, optional
Set the value field name of the sqlite service to
read/write.
Default to `value` if not specified.
Returns
-------
AsyncOperator
The new `AsyncOperator` for `sqlite` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Swift, typing.Literal["swift"]],
/,
*,
container: builtins.str = ...,
endpoint: builtins.str = ...,
root: builtins.str = ...,
token: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `swift` service.
Parameters
----------
container : builtins.str, optional
The container for Swift.
endpoint : builtins.str, optional
The endpoint for Swift.
root : builtins.str, optional
The root for Swift.
token : builtins.str, optional
The token for Swift.
Returns
-------
AsyncOperator
The new `AsyncOperator` for `swift` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Upyun, typing.Literal["upyun"]],
/,
*,
bucket: builtins.str,
operator: builtins.str = ...,
password: builtins.str = ...,
root: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `upyun` service.
Parameters
----------
bucket : builtins.str
bucket address of this backend.
operator : builtins.str, optional
username of this backend.
password : builtins.str, optional
password of this backend.
root : builtins.str, optional
root of this backend.
All operations will happen under this root.
Returns
-------
AsyncOperator
The new `AsyncOperator` for `upyun` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.VercelArtifacts, typing.Literal["vercel-artifacts"]],
/,
*,
access_token: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `vercel-artifacts` service.
Parameters
----------
access_token : builtins.str, optional
The access token for Vercel.
Returns
-------
AsyncOperator
The new `AsyncOperator` for `vercel-artifacts` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Webdav, typing.Literal["webdav"]],
/,
*,
disable_copy: builtins.bool = ...,
endpoint: builtins.str = ...,
password: builtins.str = ...,
root: builtins.str = ...,
token: builtins.str = ...,
username: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `webdav` service.
Parameters
----------
disable_copy : builtins.bool, optional
WebDAV Service doesn't support copy.
endpoint : builtins.str, optional
endpoint of this backend
password : builtins.str, optional
password of this backend
root : builtins.str, optional
root of this backend
token : builtins.str, optional
token of this backend
username : builtins.str, optional
username of this backend
Returns
-------
AsyncOperator
The new `AsyncOperator` for `webdav` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.Webhdfs, typing.Literal["webhdfs"]],
/,
*,
atomic_write_dir: builtins.str = ...,
delegation: builtins.str = ...,
disable_list_batch: builtins.bool = ...,
endpoint: builtins.str = ...,
root: builtins.str = ...,
user_name: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `webhdfs` service.
Parameters
----------
atomic_write_dir : builtins.str, optional
atomic_write_dir of this backend
delegation : builtins.str, optional
Delegation token for webhdfs.
disable_list_batch : builtins.bool, optional
Disable batch listing
endpoint : builtins.str, optional
Endpoint for webhdfs.
root : builtins.str, optional
Root for webhdfs.
user_name : builtins.str, optional
Name of the user for webhdfs.
Returns
-------
AsyncOperator
The new `AsyncOperator` for `webhdfs` service
"""
"#
}
}
submit! {
gen_methods_from_python! {
r#"
import builtins
import typing
import typing_extensions
import opendal.services
class AsyncOperator:
@overload
def __new__(cls,
scheme: typing.Union[opendal.services.Scheme.YandexDisk, typing.Literal["yandex-disk"]],
/,
*,
access_token: builtins.str,
root: builtins.str = ...,
) -> typing_extensions.Self:
r"""
Create a new `AsyncOperator` for `yandex-disk` service.
Parameters
----------
access_token : builtins.str
yandex disk oauth access_token.
root : builtins.str, optional
root of this backend.
All operations will happen under this root.
Returns
-------
AsyncOperator
The new `AsyncOperator` for `yandex-disk` service
"""
"#
}
}
macro_rules! impl_enum_to_str {
($src:ty { $(
$(#[$cfg:meta])?
$variant:ident => $value:literal
),* $(,)? }) => {
impl From<$src> for &'static str {
fn from(value: $src) -> Self {
match value {
$(
$(#[$cfg])?
<$src>::$variant => $value,
)*
}
}
}
impl From<$src> for String {
fn from(value: $src) -> Self {
let v: &'static str = value.into();
v.to_string()
}
}
};
}
impl_enum_to_str!(
PyScheme {
#[cfg(feature = "services-aliyun-drive")]
AliyunDrive => "aliyun-drive",
#[cfg(feature = "services-alluxio")]
Alluxio => "alluxio",
#[cfg(feature = "services-azblob")]
Azblob => "azblob",
#[cfg(feature = "services-azdls")]
Azdls => "azdls",
#[cfg(feature = "services-azfile")]
Azfile => "azfile",
#[cfg(feature = "services-b2")]
B2 => "b2",
#[cfg(feature = "services-cacache")]
Cacache => "cacache",
#[cfg(feature = "services-cos")]
Cos => "cos",
#[cfg(feature = "services-dashmap")]
Dashmap => "dashmap",
#[cfg(feature = "services-dropbox")]
Dropbox => "dropbox",
#[cfg(feature = "services-fs")]
Fs => "fs",
#[cfg(feature = "services-ftp")]
Ftp => "ftp",
#[cfg(feature = "services-gcs")]
Gcs => "gcs",
#[cfg(feature = "services-gdrive")]
Gdrive => "gdrive",
#[cfg(feature = "services-ghac")]
Ghac => "ghac",
#[cfg(feature = "services-gridfs")]
Gridfs => "gridfs",
#[cfg(feature = "services-hdfs-native")]
HdfsNative => "hdfs-native",
#[cfg(feature = "services-http")]
Http => "http",
#[cfg(feature = "services-huggingface")]
Huggingface => "huggingface",
#[cfg(feature = "services-ipfs")]
Ipfs => "ipfs",
#[cfg(feature = "services-ipmfs")]
Ipmfs => "ipmfs",
#[cfg(feature = "services-koofr")]
Koofr => "koofr",
#[cfg(feature = "services-memcached")]
Memcached => "memcached",
#[cfg(feature = "services-memory")]
Memory => "memory",
#[cfg(feature = "services-mini-moka")]
MiniMoka => "mini-moka",
#[cfg(feature = "services-moka")]
Moka => "moka",
#[cfg(feature = "services-mongodb")]
Mongodb => "mongodb",
#[cfg(feature = "services-mysql")]
Mysql => "mysql",
#[cfg(feature = "services-obs")]
Obs => "obs",
#[cfg(feature = "services-onedrive")]
Onedrive => "onedrive",
#[cfg(feature = "services-oss")]
Oss => "oss",
#[cfg(feature = "services-persy")]
Persy => "persy",
#[cfg(feature = "services-postgresql")]
Postgresql => "postgresql",
#[cfg(feature = "services-redb")]
Redb => "redb",
#[cfg(feature = "services-redis")]
Redis => "redis",
#[cfg(feature = "services-s3")]
S3 => "s3",
#[cfg(feature = "services-seafile")]
Seafile => "seafile",
#[cfg(feature = "services-sftp")]
Sftp => "sftp",
#[cfg(feature = "services-sled")]
Sled => "sled",
#[cfg(feature = "services-sqlite")]
Sqlite => "sqlite",
#[cfg(feature = "services-swift")]
Swift => "swift",
#[cfg(feature = "services-upyun")]
Upyun => "upyun",
#[cfg(feature = "services-vercel-artifacts")]
VercelArtifacts => "vercel-artifacts",
#[cfg(feature = "services-webdav")]
Webdav => "webdav",
#[cfg(feature = "services-webhdfs")]
Webhdfs => "webhdfs",
#[cfg(feature = "services-yandex-disk")]
YandexDisk => "yandex-disk",
}
);
```