DOC-440 | Add interface examples for APIs and GUI (Concepts section) #648

Simran-B · 2024-12-04T15:08:35Z

Description

Add examples for all official drivers, cURL, and the web interface to the pages under Concepts > Data structure for common operations that were previously only described for arangosh.

The driver code examples must be reviewed and possibly adjusted to include some error handling.
Up for discussion: How much should the examples show? For example, should setting options like returnNew be covered or should the examples rather be kept as minimal as possible?

Preview: https://deploy-preview-648--docs-hugo.netlify.app/stable/concepts/data-structure/databases/#set-the-database-context ff.

Upstream PRs

3.10:
3.11:
3.12: arangodb/enterprise:3.12.3
3.13:

arangodb-docs-automation · 2024-12-04T15:08:38Z

Deploy Preview Available Via
https://deploy-preview-648--docs-hugo.netlify.app

Simran-B · 2024-12-04T15:23:50Z

/generate

… examples

Simran-B · 2024-12-09T13:15:19Z

/generate

…-440-concepts

pluma4345

I've only checked the arangojs examples but they LGTM

rashtao · 2025-01-15T14:44:48Z

site/content/3.12/concepts/data-structure/collections.md

+
+{{< tab "Java" >}}
+```java
+ArangoCollection coll = db.collection("coll");


Suggested change

ArangoCollection coll = db.collection("coll");

CollectionEntity coll = db.collection("coll").getInfo();

rashtao · 2025-01-15T14:46:50Z

site/content/3.12/concepts/data-structure/collections.md

+ArangoCollection coll = db.collection("coll");
+```
+
+See [`ArangoDB.collection()`](https://www.javadoc.io/doc/com.arangodb/arangodb-java-driver/latest/com/arangodb/ArangoDB.html#db%28java.lang.String%29)


Suggested change

See [`ArangoDB.collection()`](https://www.javadoc.io/doc/com.arangodb/arangodb-java-driver/latest/com/arangodb/ArangoDB.html#db%28java.lang.String%29)

See [`ArangoCollection.getInfo()`](https://www.javadoc.io/static/com.arangodb/arangodb-java-driver/latest/com/arangodb/ArangoCollection.html#getInfo())

rashtao · 2025-01-15T14:51:51Z

site/content/3.12/concepts/data-structure/collections.md

+{{< tab "Java" >}}
+```java
+CollectionPropertiesOptions options = new CollectionPropertiesOptions()
+  .waitForSync(true);


Suggested change

.waitForSync(true);

.waitForSync(true)

.replicationFactor(ReplicationFactor.of(3));

rashtao · 2025-01-15T14:52:14Z

site/content/3.12/concepts/data-structure/collections.md

+ArangoCollection coll = db.collection("coll");
+CollectionPropertiesEntity props = coll.changeProperties(options);
+```
+{{< comment >}}TODO: setReplicationFactor not yet supported by Java driver{{< /comment >}}


Suggested change

{{< comment >}}TODO: setReplicationFactor not yet supported by Java driver{{< /comment >}}

rashtao · 2025-01-15T15:15:23Z

site/content/3.12/concepts/data-structure/documents/_index.md

+CollectionEntity coll = db.collection("coll");
+
+// Single document
+coll.insertDocument(new BaseDocument("the-document-key")
+  .addAttribute("name", "ArangoDB")
+  .addAttribute("tags", [ "graph", "database", "NoSQL" ])
+  .addAttribute("scalable", true)
+  .addAttribute("company", new Map<String, Object>()
+    .put("name", "ArangoDB Inc.")
+    .put("founded", 2015)
+  )
+  .addAttribute("name", "ArangoDB")
+);
+
+// Multiple documents
+coll.insertDocuments([
+  new BaseDocument("one"),
+  new BaseDocument("two"),
+  new BaseDocument("three")
+]);


Suggested change

CollectionEntity coll = db.collection("coll");

// Single document

coll.insertDocument(new BaseDocument("the-document-key")

.addAttribute("name", "ArangoDB")

.addAttribute("tags", [ "graph", "database", "NoSQL" ])

.addAttribute("scalable", true)

.addAttribute("company", new Map<String, Object>()

.put("name", "ArangoDB Inc.")

.put("founded", 2015)

)

.addAttribute("name", "ArangoDB")

);

// Multiple documents

coll.insertDocuments([

new BaseDocument("one"),

new BaseDocument("two"),

new BaseDocument("three")

]);

ArangoCollection coll = db.collection("coll");

// Single document

BaseDocument doc = new BaseDocument("the-document-key");

doc.addAttribute("name", "ArangoDB");

doc.addAttribute("tags", List.of("graph", "database", "NoSQL"));

doc.addAttribute("scalable", true);

doc.addAttribute("company", Map.of(

"name", "ArangoDB Inc.",

"founded", 2015

));

doc.addAttribute("name", "ArangoDB");

coll.insertDocument(doc);

// Multiple documents

coll.insertDocuments(List.of(

new BaseDocument("one"),

new BaseDocument("two"),

new BaseDocument("three")

));

rashtao · 2025-01-15T15:34:30Z

site/content/3.12/concepts/data-structure/documents/_index.md

+// Single document
+DocumentDeleteEntity<Void> result = coll.deleteDocument("the-document-key");
+
+// Multiple documents
+for (MultiDocumentEntity<DocumentDeleteEntity<Void>> result : coll.deleteDocuments(["one", "two", "three"])) {
+  // ...
+}


Suggested change

// Single document

DocumentDeleteEntity<Void> result = coll.deleteDocument("the-document-key");

// Multiple documents

for (MultiDocumentEntity<DocumentDeleteEntity<Void>> result : coll.deleteDocuments(["one", "two", "three"])) {

// ...

}

// Single document

DocumentDeleteEntity<Void> result = coll.deleteDocument("the-document-key");

// Multiple documents

MultiDocumentEntity<DocumentDeleteEntity<Void>> multipleResult =

coll.deleteDocuments(List.of("one", "two", "three"));

rashtao · 2025-01-15T15:37:20Z

site/content/3.12/concepts/data-structure/documents/schema-validation.md

+String schemaRule = (
+    "{" +
+    "  \"type\": \"object\"," +
+    "  \"properties\": {" +
+    "    \"nums\": {" +
+    "      \"type\": \"array\"," +
+    "      \"items\": {" +
+    "        \"type\": \"number\"," +
+    "        \"minimum\": 6" +
+    "      }" +
+    "    }" +
+    "  }," +
+    "  \"additionalProperties\": { \"type\": \"string\" }," +
+    "  \"required\": [\"nums\"]" +
+    "}");
+
+CollectionPropertiesOptions props = new CollectionPropertiesOptions()
+  .schema(new CollectionSchema()
+    .setRule(schemaRule)
+    .setLevel(CollectionSchema.Level.MODERATE)
+    .setMessage("The document does not contain an array of numbers in attribute \"nums\", one of the numbers is greater than 6, or another top-level attribute is not a string.")
+  );
+
+ArangoCollection coll = db.collection("coll");
+CollectionPropertiesEntity = coll.changeProperties(props);


Suggested change

String schemaRule = (

"{" +

" \"type\": \"object\"," +

" \"properties\": {" +

" \"nums\": {" +

" \"type\": \"array\"," +

" \"items\": {" +

" \"type\": \"number\"," +

" \"minimum\": 6" +

" }" +

" }" +

" }," +

" \"additionalProperties\": { \"type\": \"string\" }," +

" \"required\": [\"nums\"]" +

"}");

CollectionPropertiesOptions props = new CollectionPropertiesOptions()

.schema(new CollectionSchema()

.setRule(schemaRule)

.setLevel(CollectionSchema.Level.MODERATE)

.setMessage("The document does not contain an array of numbers in attribute \"nums\", one of the numbers is greater than 6, or another top-level attribute is not a string.")

);

ArangoCollection coll = db.collection("coll");

CollectionPropertiesEntity = coll.changeProperties(props);

String schemaRule = (

"{" +

" \"type\": \"object\"," +

" \"properties\": {" +

" \"nums\": {" +

" \"type\": \"array\"," +

" \"items\": {" +

" \"type\": \"number\"," +

" \"minimum\": 6" +

" }" +

" }" +

" }," +

" \"additionalProperties\": { \"type\": \"string\" }," +

" \"required\": [\"nums\"]" +

"}");

CollectionPropertiesOptions props = new CollectionPropertiesOptions()

.schema(new CollectionSchema()

.setRule(schemaRule)

.setLevel(CollectionSchema.Level.MODERATE)

.setMessage("The document does not contain an array of numbers in attribute \"nums\", one of the numbers is greater than 6, or another top-level attribute is not a string.")

);

ArangoCollection coll = db.collection("coll");

CollectionPropertiesEntity changedProperties = coll.changeProperties(props);

rashtao · 2025-01-15T15:41:43Z

site/content/3.12/concepts/data-structure/views.md

+ArangoView view = db.view("myView");
+
+ArangoSearch viewSearch = db.arangoSearch("myArangoSearchView");
+SearchAlias viewAlias = db.searchAlias("mySearchAliasView");


Suggested change

ArangoView view = db.view("myView");

ArangoSearch viewSearch = db.arangoSearch("myArangoSearchView");

SearchAlias viewAlias = db.searchAlias("mySearchAliasView");

ViewEntity view = db.view("myView").getInfo();

ViewEntity viewSearch = db.arangoSearch("myArangoSearchView").getInfo();

ViewEntity viewAlias = db.searchAlias("mySearchAliasView").getInfo();

rashtao · 2025-01-15T15:46:22Z

site/content/3.12/concepts/data-structure/views.md

+ArangoSearch viewSearch = db.view("myArangoSearchView"); 
+ArangoSearchPropertiesEntity viewSearch.getProperties();
+
+SearchAlias viewAlias = db.view("mySearchAliasView"); 
+SearchAliasPropertiesEntity viewAlias.getProperties();


Suggested change

ArangoSearch viewSearch = db.view("myArangoSearchView");

ArangoSearchPropertiesEntity viewSearch.getProperties();

SearchAlias viewAlias = db.view("mySearchAliasView");

SearchAliasPropertiesEntity viewAlias.getProperties();

ArangoSearch viewSearch = db.arangoSearch("myArangoSearchView");

ArangoSearchPropertiesEntity viewSearchProperties = viewSearch.getProperties();

SearchAlias viewAlias = db.searchAlias("mySearchAliasView");

SearchAliasPropertiesEntity viewAliasProperties = viewAlias.getProperties();

rashtao · 2025-01-15T15:50:50Z

site/content/3.12/concepts/data-structure/views.md

+ArangoSearchPropertiesOptions options = new ArangoSearchPropertiesOptions();
+options.cleanupIntervalStep(12L);
+options.link(CollectionLink.on("coll")
+  .includeAllFields(true)
+);
+
+ArangoSearch viewSearch = db.view("myArangoSearchView"); 
+ArangoSearchPropertiesEntity viewSearch.updateProperties(options);
+
+SearchAlias viewAlias = db.view("mySearchAliasView"); 
+SearchAliasPropertiesEntity viewAlias.updateProperties(
+  new SearchAliasPropertiesOptions()
+    .indexes(new SearchAliasIndex("coll", "idx"))
+);


Suggested change

ArangoSearchPropertiesOptions options = new ArangoSearchPropertiesOptions();

options.cleanupIntervalStep(12L);

options.link(CollectionLink.on("coll")

.includeAllFields(true)

);

ArangoSearch viewSearch = db.view("myArangoSearchView");

ArangoSearchPropertiesEntity viewSearch.updateProperties(options);

SearchAlias viewAlias = db.view("mySearchAliasView");

SearchAliasPropertiesEntity viewAlias.updateProperties(

new SearchAliasPropertiesOptions()

.indexes(new SearchAliasIndex("coll", "idx"))

);

ArangoSearch viewSearch = db.arangoSearch("myArangoSearchView");

ArangoSearchPropertiesEntity viewSearchProperties = viewSearch.updateProperties(

new ArangoSearchPropertiesOptions()

.cleanupIntervalStep(12L)

.link(CollectionLink.on("coll")

.includeAllFields(true)

)

);

SearchAlias viewAlias = db.searchAlias("mySearchAliasView");

SearchAliasPropertiesEntity viewAliasProperties = viewAlias.updateProperties(

new SearchAliasPropertiesOptions()

.indexes(new SearchAliasIndex("coll", "idx"))

);

… for endpoints that require this context

…-440-concepts

Simran-B · 2025-01-20T21:43:32Z

site/content/3.12/concepts/data-structure/documents/computed-values.md

+    .name("title")
+    .expression("RETURN \"TBA\"")
+    .overwrite(false)
+    .computeOn(ComputeOn.insert, ComputeOn.update, ComputeOn.replace)


@rashtao I added the examples for Computed Values now too.
Is it necessary to use ComputedValue.ComputeOn.* here to refer to the elements of the enum?

Suggested change

.computeOn(ComputeOn.insert, ComputeOn.update, ComputeOn.replace)

.computeOn(ComputedValue.ComputeOn.insert, ComputedValue.ComputeOn.update, ComputedValue.ComputeOn.replace)

aMahanna

Python examples look good,2 small adjustments:

aMahanna · 2025-01-21T02:48:51Z

site/content/3.12/concepts/data-structure/documents/computed-values.md

+```py
+coll = db.collection("coll")
+props = coll.configure(
+  computed_values: [


Suggested change

computed_values: [

computed_values=[

aMahanna · 2025-01-21T02:52:03Z

site/content/3.12/concepts/data-structure/documents/_index.md

+
+{{< tab "Python" >}}
+```py
+coll = db.get_collection("coll")


Suggested change

coll = db.get_collection("coll")

coll = db.collection("coll")

Add interface examples for databases, collection, Views

cb351dd

Simran-B self-assigned this Dec 4, 2024

cla-bot bot added the cla-signed label Dec 4, 2024

Simran-B added the 9 Waiting for CI label Dec 4, 2024

Simran-B added 2 commits December 9, 2024 13:48

Explicitly use _system database for endpoints that require it in curl…

ddce1c8

… examples

Simpler collection properties examples, use _system db where necessary

d52bde4

Simran-B added 2 commits December 17, 2024 21:49

More examples, fixes

11ec902

Merge branch 'main' of https://github.com/arangodb/docs-hugo into DOC…

59ece1d

…-440-concepts

Simran-B requested review from rashtao, jwierzbo, aMahanna and pluma4345 December 17, 2024 20:54

Simran-B added 2 commits December 17, 2024 21:55

Fix link

863a3ff

Fix another link

52c9e86

Simran-B marked this pull request as ready for review December 17, 2024 21:12

pluma4345 approved these changes Jan 15, 2025

View reviewed changes

rashtao requested changes Jan 15, 2025

View reviewed changes

Simran-B changed the title ~~DOC-440 | Add interface examples for APIs and GUI~~ DOC-440 | Add interface examples for APIs and GUI (Concepts section) Jan 20, 2025

Simran-B added 4 commits January 20, 2025 22:17

README: cURL example can fail if the URL doesn't specify /_db/_system…

05c8e55

… for endpoints that require this context

Fix arangosh example ID

da0cdf8

Computed values interface examples

34923f1

Merge branch 'main' of https://github.com/arangodb/docs-hugo into DOC…

0af31c4

…-440-concepts

Simran-B commented Jan 20, 2025

View reviewed changes

aMahanna requested changes Jan 21, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC-440 | Add interface examples for APIs and GUI (Concepts section) #648

DOC-440 | Add interface examples for APIs and GUI (Concepts section) #648

Simran-B commented Dec 4, 2024 •

edited

Loading

arangodb-docs-automation bot commented Dec 4, 2024

Simran-B commented Dec 4, 2024

Simran-B commented Dec 9, 2024

pluma4345 left a comment

rashtao Jan 15, 2025

rashtao Jan 15, 2025

rashtao Jan 15, 2025

rashtao Jan 15, 2025

rashtao Jan 15, 2025

rashtao Jan 15, 2025

rashtao Jan 15, 2025

rashtao Jan 15, 2025

rashtao Jan 15, 2025

rashtao Jan 15, 2025

Simran-B Jan 20, 2025

rashtao Jan 21, 2025

aMahanna left a comment

aMahanna Jan 21, 2025

aMahanna Jan 21, 2025

	ArangoCollection coll = db.collection("coll");
	CollectionEntity coll = db.collection("coll").getInfo();

	See [`ArangoDB.collection()`](https://www.javadoc.io/doc/com.arangodb/arangodb-java-driver/latest/com/arangodb/ArangoDB.html#db%28java.lang.String%29)
	See [`ArangoCollection.getInfo()`](https://www.javadoc.io/static/com.arangodb/arangodb-java-driver/latest/com/arangodb/ArangoCollection.html#getInfo())

	.waitForSync(true);
	.waitForSync(true)
	.replicationFactor(ReplicationFactor.of(3));

	.computeOn(ComputeOn.insert, ComputeOn.update, ComputeOn.replace)
	.computeOn(ComputedValue.ComputeOn.insert, ComputedValue.ComputeOn.update, ComputedValue.ComputeOn.replace)

	coll = db.get_collection("coll")
	coll = db.collection("coll")

DOC-440 | Add interface examples for APIs and GUI (Concepts section) #648

Are you sure you want to change the base?

DOC-440 | Add interface examples for APIs and GUI (Concepts section) #648

Conversation

Simran-B commented Dec 4, 2024 • edited Loading

Description

Upstream PRs

arangodb-docs-automation bot commented Dec 4, 2024

Simran-B commented Dec 4, 2024

Simran-B commented Dec 9, 2024

pluma4345 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aMahanna left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Simran-B commented Dec 4, 2024 •

edited

Loading