feat(core): add new cap shared (#5328)

bindings/c/include/opendal.h

@@ -585,6 +585,10 @@ typedef struct opendal_capability {
    * If it is not set, this will be zero
    */
   uintptr_t batch_max_operations;
+  /**
+   * If operator supports shared.
+   */
+  bool shared;
   /**
    * If operator supports blocking.
    */

bindings/c/src/operator_info.rs

@@ -135,6 +135,9 @@ pub struct opendal_capability {
     /// If it is not set, this will be zero
     pub batch_max_operations: usize,
 
+    /// If operator supports shared.
+    pub shared: bool,
+
     /// If operator supports blocking.
     pub blocking: bool,
 }
@@ -263,6 +266,7 @@ impl From<core::Capability> for opendal_capability {
             batch: value.batch,
             batch_delete: value.batch_delete,
             batch_max_operations: value.batch_max_operations.unwrap_or(0),
+            shared: value.shared,
             blocking: value.blocking,
         }
     }

bindings/go/operator_info.go

@@ -240,6 +240,10 @@ func (c *Capability) BatchMaxOperations() uint {
 	return c.inner.batchMaxOperations
 }
 
+func (c *Capability) Shared() bool {
+	return c.inner.shared == 1
+}
+
 func (c *Capability) Blocking() bool {
 	return c.inner.blocking == 1
 }

bindings/go/types.go

@@ -163,6 +163,7 @@ var (
 			&ffi.TypeUint8,   // batch
 			&ffi.TypeUint8,   // batch_delete
 			&ffi.TypePointer, // batch_max_operations
+			&ffi.TypeUint8,   // shared
 			&ffi.TypeUint8,   // blocking
 			nil,
 		}[0],
@@ -204,6 +205,7 @@ type opendalCapability struct {
 	batch                              uint8
 	batchDelete                        uint8
 	batchMaxOperations                 uint
+	shared                             uint8
 	blocking                           uint8
 }
 

bindings/java/src/lib.rs

@@ -94,7 +94,7 @@ fn make_operator_info<'a>(env: &mut JNIEnv<'a>, info: OperatorInfo) -> Result<JO
 fn make_capability<'a>(env: &mut JNIEnv<'a>, cap: Capability) -> Result<JObject<'a>> {
     let capability = env.new_object(
         "org/apache/opendal/Capability",
-        "(ZZZZZZZZZZZZZZZJJZZZZZZZZZZZZZZJZ)V",
+        "(ZZZZZZZZZZZZZZZJJZZZZZZZZZZZZZZJZZ)V",
         &[
             JValue::Bool(cap.stat as jboolean),
             JValue::Bool(cap.stat_with_if_match as jboolean),
@@ -128,6 +128,7 @@ fn make_capability<'a>(env: &mut JNIEnv<'a>, cap: Capability) -> Result<JObject<
             JValue::Bool(cap.batch as jboolean),
             JValue::Bool(cap.batch_delete as jboolean),
             JValue::Long(convert::usize_to_jlong(cap.batch_max_operations)),
+            JValue::Bool(cap.shared as jboolean),
             JValue::Bool(cap.blocking as jboolean),
         ],
     )?;

bindings/java/src/main/java/org/apache/opendal/Capability.java

@@ -185,6 +185,11 @@ public class Capability {
      */
     public final long batchMaxOperations;
 
+    /**
+     * If operator supports shared.
+     */
+    public final boolean shared;
+
     /**
      * If operator supports blocking.
      */
@@ -223,7 +228,8 @@ public Capability(
             boolean batch,
             boolean batchDelete,
             long batchMaxOperations,
-            boolean blocking) {
+            boolean blocking,
+            boolean shared) {
         this.stat = stat;
         this.statWithIfMatch = statWithIfMatch;
         this.statWithIfNoneMatch = statWithIfNoneMatch;
@@ -257,5 +263,6 @@ public Capability(
         this.batchDelete = batchDelete;
         this.batchMaxOperations = batchMaxOperations;
         this.blocking = blocking;
+        this.shared = shared;
     }
 }

bindings/nodejs/generated.d.ts

@@ -192,6 +192,8 @@ export class Capability {
   get batchDelete(): boolean
   /** The max operations that operator supports in batch. */
   get batchMaxOperations(): bigint | null
+  /** If operator supports shared. */
+  get shared(): boolean
   /** If operator supports blocking. */
   get blocking(): boolean
 }

bindings/nodejs/src/capability.rs

@@ -245,6 +245,12 @@ impl Capability {
         self.0.batch_max_operations
     }
 
+    /// If operator supports shared.
+    #[napi(getter)]
+    pub fn shared(&self) -> bool {
+        self.0.shared
+    }
+
     /// If operator supports blocking.
     #[napi(getter)]
     pub fn blocking(&self) -> bool {

bindings/python/python/opendal/__init__.pyi

@@ -204,4 +204,5 @@ class Capability:
     batch_delete: bool
     batch_max_operations: Optional[int]
 
+    shared: bool
     blocking: bool

bindings/python/src/capability.rs

@@ -105,6 +105,9 @@ pub struct Capability {
     /// The max operations that operator supports in batch.
     pub batch_max_operations: Option<usize>,
 
+    /// If operator supports shared.
+    pub shared: bool,
+
     /// If operator supports blocking.
     pub blocking: bool,
 }
@@ -147,6 +150,7 @@ impl Capability {
             batch: capability.batch,
             batch_delete: capability.batch_delete,
             batch_max_operations: capability.batch_max_operations,
+            shared: capability.shared,
             blocking: capability.blocking,
         }
     }

bindings/ruby/src/capability.rs

@@ -97,7 +97,8 @@ define_accessors!(Capability, {
     batch: bool,
     batch_delete: bool,
     batch_max_operations: Option<usize>,
-    blocking: bool
+    shared: bool,
+    blocking: bool,
 });
 
 // includes class into the Ruby module

core/src/raw/adapters/typed_kv/api.rs

@@ -130,6 +130,8 @@ pub struct Capability {
     pub delete: bool,
     /// If typed_kv operator supports scan natively.
     pub scan: bool,
+    /// If typed_kv operator supports shared access.
+    pub shared: bool,
 }
 
 impl Debug for Capability {
@@ -148,6 +150,9 @@ impl Debug for Capability {
         if self.scan {
             s.push("Scan");
         }
+        if self.shared {
+            s.push("Shared");
+        }
 
         write!(f, "{{ {} }}", s.join(" | "))
     }

core/src/raw/adapters/typed_kv/backend.rs

@@ -87,6 +87,10 @@ impl<S: Adapter> Access for Backend<S> {
             cap.list_with_recursive = true;
         }
 
+        if kv_cap.shared {
+            cap.shared = true;
+        }
+
         cap.blocking = true;
 
         am.set_native_capability(cap);

core/src/services/aliyun_drive/backend.rs

@@ -230,7 +230,7 @@ impl Access for AliyunDriveBackend {
                 rename: true,
                 list: true,
                 list_with_limit: true,
-
+                shared: true,
                 ..Default::default()
             });
         am.into()

core/src/services/alluxio/backend.rs

@@ -169,6 +169,8 @@ impl Access for AlluxioBackend {
 
                 list: true,
 
+                shared: true,
+
                 ..Default::default()
             });
 

core/src/services/atomicserver/backend.rs

@@ -361,6 +361,7 @@ impl kv::Adapter for Adapter {
                 read: true,
                 write: true,
                 delete: true,
+                shared: true,
                 ..Default::default()
             },
         )

core/src/services/azblob/backend.rs

@@ -537,6 +537,8 @@ impl Access for AzblobBackend {
                 batch_delete: true,
                 batch_max_operations: Some(self.core.batch_max_operations),
 
+                shared: true,
+
                 ..Default::default()
             });
 

core/src/services/azdls/backend.rs

@@ -242,6 +242,8 @@ impl Access for AzdlsBackend {
 
                 list: true,
 
+                shared: true,
+
                 ..Default::default()
             });
 

core/src/services/azfile/backend.rs

@@ -253,6 +253,8 @@ impl Access for AzfileBackend {
 
                 list: true,
 
+                shared: true,
+
                 ..Default::default()
             });
 

core/src/services/b2/backend.rs

@@ -259,6 +259,8 @@ impl Access for B2Backend {
                 presign_write: true,
                 presign_stat: true,
 
+                shared: true,
+
                 ..Default::default()
             });
 

core/src/services/cacache/backend.rs

@@ -96,6 +96,7 @@ impl kv::Adapter for Adapter {
                 write: true,
                 delete: true,
                 blocking: true,
+                shared: false,
                 ..Default::default()
             },
         )

core/src/services/chainsafe/backend.rs

@@ -187,6 +187,8 @@ impl Access for ChainsafeBackend {
 
                 list: true,
 
+                shared: true,
+
                 ..Default::default()
             });
 

core/src/services/cloudflare_kv/backend.rs

@@ -191,6 +191,7 @@ impl kv::Adapter for Adapter {
                 read: true,
                 write: true,
                 list: true,
+                shared: true,
 
                 ..Default::default()
             },

core/src/services/compfs/backend.rs

@@ -130,6 +130,8 @@ impl Access for CompfsBackend {
                 copy: true,
                 rename: true,
 
+                shared: true,
+
                 ..Default::default()
             });
 

core/src/services/cos/backend.rs

@@ -284,6 +284,8 @@ impl Access for CosBackend {
                 presign_read: true,
                 presign_write: true,
 
+                shared: true,
+
                 ..Default::default()
             });
 

core/src/services/d1/backend.rs

@@ -270,6 +270,7 @@ impl kv::Adapter for Adapter {
                 // Cloudflare D1 supports 1MB as max in write_total.
                 // refer to https://developers.cloudflare.com/d1/platform/limits/
                 write_total_max_size: Some(1000 * 1000),
+                shared: true,
                 ..Default::default()
             },
         )

core/src/services/dashmap/backend.rs

@@ -94,6 +94,7 @@ impl typed_kv::Adapter for Adapter {
                 set: true,
                 scan: true,
                 delete: true,
+                shared: false,
             },
         )
     }

core/src/services/dbfs/backend.rs

@@ -163,6 +163,8 @@ impl Access for DbfsBackend {
 
                 list: true,
 
+                shared: true,
+
                 ..Default::default()
             });
         am.into()

core/src/services/dropbox/backend.rs

@@ -68,6 +68,8 @@ impl Access for DropboxBackend {
                 batch: true,
                 batch_delete: true,
 
+                shared: true,
+
                 ..Default::default()
             });
         ma.into()

core/src/services/etcd/backend.rs

@@ -282,6 +282,7 @@ impl kv::Adapter for Adapter {
                 read: true,
                 write: true,
                 list: true,
+                shared: true,
 
                 ..Default::default()
             },

core/src/services/foundationdb/backend.rs

@@ -120,6 +120,7 @@ impl kv::Adapter for Adapter {
                 read: true,
                 write: true,
                 delete: true,
+                shared: true,
                 ..Default::default()
             },
         )

core/src/services/fs/backend.rs

@@ -191,6 +191,8 @@ impl Access for FsBackend {
                 rename: true,
                 blocking: true,
 
+                shared: true,
+
                 ..Default::default()
             });
 

core/src/services/ftp/backend.rs

@@ -281,6 +281,8 @@ impl Access for FtpBackend {
 
                 list: true,
 
+                shared: true,
+
                 ..Default::default()
             });
 

core/src/services/gcs/backend.rs

@@ -395,6 +395,8 @@ impl Access for GcsBackend {
                 presign_read: true,
                 presign_write: true,
 
+                shared: true,
+
                 ..Default::default()
             });
         am.into()

core/src/services/gdrive/backend.rs

@@ -64,6 +64,9 @@ impl Access for GdriveBackend {
                 delete: true,
                 rename: true,
                 copy: true,
+
+                shared: true,
+
                 ..Default::default()
             });
 

core/src/services/ghac/backend.rs

@@ -248,6 +248,8 @@ impl Access for GhacBackend {
                 write_can_multi: true,
                 delete: true,
 
+                shared: true,
+
                 ..Default::default()
             });
         am.into()

core/src/services/github/backend.rs

@@ -199,6 +199,8 @@ impl Access for GithubBackend {
                 list: true,
                 list_with_recursive: true,
 
+                shared: true,
+
                 ..Default::default()
             });