This is an automated email from the ASF dual-hosted git repository.
xuanwo pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/opendal.git
The following commit(s) were added to refs/heads/main by this push:
new 8f2ab60b82 docs: Enhance maintainability of the service section (#4742)
8f2ab60b82 is described below
commit 8f2ab60b82686309e5f7b22c3ca73598457c6b29
Author: Xuanwo <[email protected]>
AuthorDate: Sun Jun 16 12:17:57 2024 +0800
docs: Enhance maintainability of the service section (#4742)
Signed-off-by: Xuanwo <[email protected]>
---
README.md | 84 +++++++++++++++++++++++++++++++++++++++++++++++++++++++--------
1 file changed, 74 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
index 1f7ed0a3a4..a50c81f86e 100644
--- a/README.md
+++ b/README.md
@@ -104,19 +104,83 @@ OpenDAL offers a unified data access layer, empowering
users to seamlessly and e
## For *ANY* services
-| Type | Services
[...]
-|--------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
-| Standard Storage Protocols | ftp, http,
[sftp](https://datatracker.ietf.org/doc/html/draft-ietf-secsh-filexfer-02),
[webdav](https://datatracker.ietf.org/doc/html/rfc4918), ..
[...]
-| Object Storage Services |
[azblob](https://azure.microsoft.com/en-us/services/storage/blobs/),
[cos](https://www.tencentcloud.com/products/cos),
[gcs](https://cloud.google.com/storage),
[obs](https://www.huaweicloud.com/intl/en-us/product/obs.html),
[oss](https://www.aliyun.com/product/oss), [s3](https://aws.amazon.com/s3/),
[supabase](https://supabase.com/docs/guides/storage),
[b2](https://www.backblaze.com/), [openstack
swift](https://docs.openstack.org/swift/latest/), [upyun] [...]
-| File Storage Services | fs,
[alluxio](https://docs.alluxio.io/os/user/stable/en/api/REST-API.html),
[azdls](https://azure.microsoft.com/en-us/products/storage/data-lake-storage/),
[azfile](https://learn.microsoft.com/en-us/rest/api/storageservices/file-service-rest-api),
[chainsafe](https://storage.chainsafe.io/),
[dbfs](https://docs.databricks.com/en/dbfs/index.html),
[gridfs](https://www.mongodb.com/docs/manual/core/gridfs/),
[hdfs](https://hadoop.apache.org/docs/r3.3.4/hado [...]
-| Consumer Cloud Storage Service | [gdrive](https://www.google.com/drive/),
[onedrive](https://www.microsoft.com/en-us/microsoft-365/onedrive/online-cloud-storage),
[dropbox](https://www.dropbox.com/),
[icloud](https://www.icloud.com/iclouddrive), [koofr](https://koofr.eu/),
[pcloud](https://www.pcloud.com/), [seafile](https://www.seafile.com/),
[yandex_disk](https://360.yandex.com/disk/), ..
[...]
-| Key-Value Storage Services |
[cacache](https://crates.io/crates/cacache),
[cloudflare_kv](https://developers.cloudflare.com/kv/),
[dashmap](https://github.com/xacrimon/dashmap), memory,
[etcd](https://etcd.io/), [foundationdb](https://www.foundationdb.org/),
[persy](https://crates.io/crates/persy), [redis](https://redis.io/),
[rocksdb](http://rocksdb.org/), [sled](https://crates.io/crates/sled),
[redb](https://crates.io/crates/redb), [tikv](https://tikv.org/),
[atomicserver](https: [...]
-| Database Storage Services |
[d1](https://developers.cloudflare.com/d1/),
[libsql](https://github.com/tursodatabase/libsql),
[mongodb](https://www.mongodb.com/), [mysql](https://www.mysql.com/),
[postgresql](https://www.postgresql.org/), [sqlite](https://www.sqlite.org/),
..
[...]
-| Cache Storage Services |
[ghac](https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows),
[memcached](https://memcached.org/),
[mini_moka](https://github.com/moka-rs/mini-moka),
[moka](https://github.com/moka-rs/moka),
[vercel_artifacts](https://vercel.com/docs/concepts/monorepos/remote-caching),
..
[...]
-| Git Based Storage Services | [huggingface](https://huggingface.co/), ..
[...]
+| Type | Services
|
+|--------------------------------|--------------------------------------------------------------------------------------------------------------------------------|
+| Standard Storage Protocols | ftp http [sftp] [webdav]
|
+| Object Storage Services | [azblob] [cos] [gcs] [obs] [oss] [s3] [b2]
[openstack_swift] [upyun] [vercel_blob]
|
+| File Storage Services | fs [alluxio] [azdls] [azfile] [chainsafe]
[compfs] [dbfs] [gridfs] [hdfs] [hdfs_native] [ipfs] [webhdfs]
|
+| Consumer Cloud Storage Service | [aliyun_drive] [gdrive] [onedrive]
[dropbox] [icloud] [koofr] [pcloud] [seafile] [yandex_disk]
|
+| Key-Value Storage Services | [cacache] [cloudflare_kv] [dashmap] memory
[etcd] [foundationdb] [persy] [redis] [rocksdb] [sled] [redb] [tikv]
[atomicserver] |
+| Database Storage Services | [d1] [mongodb] [mysql] [postgresql]
[sqlite] [surrealdb]
|
+| Cache Storage Services | [ghac] [memcached] [mini_moka] [moka]
[vercel_artifacts]
|
+| Git Based Storage Services | [huggingface]
|
> Welcome to add any services that are not currently supported
> [here](https://github.com/apache/opendal/issues/5).
+[sftp]: https://datatracker.ietf.org/doc/html/draft-ietf-secsh-filexfer-02
+[webdav]: https://datatracker.ietf.org/doc/html/rfc4918
+
+[azblob]: https://azure.microsoft.com/en-us/services/storage/blobs/
+[cos]: https://www.tencentcloud.com/products/cos
+[gcs]: https://cloud.google.com/storage
+[obs]: https://www.huaweicloud.com/intl/en-us/product/obs.html
+[oss]: https://www.aliyun.com/product/oss
+[s3]: https://aws.amazon.com/s3/
+[b2]: https://www.backblaze.com/
+[openstack_swift]: https://docs.openstack.org/swift/latest/
+[upyun]: https://www.upyun.com/
+[vercel_blob]: https://vercel.com/docs/storage/vercel-blob
+
+[alluxio]: https://docs.alluxio.io/os/user/stable/en/api/REST-API.html
+[azdls]: https://azure.microsoft.com/en-us/products/storage/data-lake-storage/
+[azfile]:
https://learn.microsoft.com/en-us/rest/api/storageservices/file-service-rest-api
+[chainsafe]: https://storage.chainsafe.io/
+[compfs]: https://github.com/compio-rs/compio/
+[dbfs]: https://docs.databricks.com/en/dbfs/index.html
+[gridfs]: https://www.mongodb.com/docs/manual/core/gridfs/
+[hdfs]:
https://hadoop.apache.org/docs/r3.3.4/hadoop-project-dist/hadoop-hdfs/HdfsDesign.html
+[hdfs_native]: https://github.com/Kimahriman/hdfs-native
+[ipfs]: https://ipfs.tech/
+[webhdfs]:
https://hadoop.apache.org/docs/stable/hadoop-project-dist/hadoop-hdfs/WebHDFS.html
+
+[aliyun_drive]: https://www.aliyundrive.com/
+[gdrive]: https://www.google.com/drive/
+[onedrive]:
https://www.microsoft.com/en-us/microsoft-365/onedrive/online-cloud-storage
+[dropbox]: https://www.dropbox.com/
+[icloud]: https://www.icloud.com/iclouddrive
+[koofr]: https://koofr.eu/
+[pcloud]: https://www.pcloud.com/
+[seafile]: https://www.seafile.com/
+[yandex_disk]: https://360.yandex.com/disk/
+
+[cacache]: https://crates.io/crates/cacache
+[cloudflare_kv]: https://developers.cloudflare.com/kv/
+[dashmap]: https://github.com/xacrimon/dashmap
+[etcd]: https://etcd.io/
+[foundationdb]: https://www.foundationdb.org/
+[persy]: https://crates.io/crates/persy
+[redis]: https://redis.io/
+[rocksdb]: http://rocksdb.org/
+[sled]: https://crates.io/crates/sled
+[redb]: https://crates.io/crates/redb
+[tikv]: https://tikv.org/
+[atomicserver]: https://github.com/atomicdata-dev/atomic-server
+
+[d1]: https://developers.cloudflare.com/d1/
+[mongodb]: https://www.mongodb.com/
+[mysql]: https://www.mysql.com/
+[postgresql]: https://www.postgresql.org/
+[sqlite]: https://www.sqlite.org/
+[surrealdb]: https://surrealdb.com/
+
+[ghac]:
https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows
+[memcached]: https://memcached.org/
+[mini_moka]: https://github.com/moka-rs/mini-moka
+[moka]: https://github.com/moka-rs/moka
+[vercel_artifacts]: https://vercel.com/docs/concepts/monorepos/remote-caching
+
+[huggingface]: https://huggingface.co/
+
## Examples
The examples are available at [here](./examples/).
