GitHub user linghengqian closed a discussion: In java binding, how to know what 
`Construct operator` requires?

- I admit this is a naive question, but I don't seem to notice any 
documentation explaining this.
- In https://opendal.apache.org/docs/quickstart#demo-1 , there is code like 
this,
```java
// Configure service
final Map<String, String> conf = new HashMap<>();
conf.put("root", "/tmp");
// Construct operator
final Operator op = Operator.of("fs", conf);
// Write data
op.write("hello.txt", "Hello, World!").join();
// Read data
final byte[] bs = op.read("hello.txt").join();
// Delete
op.delete("hello.txt").join();
```
- Of course, I certainly don't believe that OpenDAL's java binding only 
supports `fs`. But how do I know that `fs` requires a `Map` containing a 
key-value pair called `root`? Also, how do I know the name of the other 
filesystems besides `Operator.of("fs", conf)`?
- I assume the string for `fs` comes from the image below?
- 
![image](https://github.com/user-attachments/assets/f1342817-a8cd-43f6-a568-58874a4aaafe)
- I see https://github.com/apache/opendal/issues/4279 is not done yet. It 
sounds like the documentation needs to properly state that users of the Java 
binding need to be able to read Rust source code? Documents like 
https://vuejs.org/guide/introduction.html#what-is-vue require readers of Vue's 
documentation to know HTML, CSS, and JavaScript at specific URLs in advance. 
Does the Java binding documentation for OpenDAL also need to state the URL of 
the Rust documentation?

- 
![image](https://github.com/user-attachments/assets/d2cf3c09-c065-481c-88f4-a7ab078cd0c9)



GitHub link: https://github.com/apache/opendal/discussions/5402

----
This is an automatically sent email for [email protected].
To unsubscribe, please send an email to: [email protected]

Reply via email to