8000 docs for APM-132 by jsteemann · Pull Request #14675 · arangodb/arangodb · GitHub
[go: up one dir, main page]
Skip to content

docs for APM-132 #14675

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 23, 2021
Merged

docs for APM-132 #14675

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
docs for APM-132
  • Loading branch information
@jsteemann
jsteemann committed Aug 23, 2021
commit 84dce75d1c9d3c6342c51fc9d05cb5f2253ead4c
6 changes: 1 addition & 5 deletions Documentation/DocuBlocks/Rest/Collections/get_api_collection_name.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,18 +24,14 @@ attributes:
- *name*: The name of the collection.

- *status*: The status of the collection as number.
- 1: new born collection
- 2: unloaded
- 3: loaded
- 4: in the process of being unloaded
- 5: deleted
- 6: loading

Every other status indicates a corrupted collection.

- *type*: The type of the collection as number.
- 2: document collection (normal case)
- 3: edges collection
- 3: edge collection

- *isSystem*: If *true* then the collection is a system collection.

Expand Down
12 changes: 8 additions & 4 deletions Documentation/DocuBlocks/Rest/Collections/put_api_collection_load.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@

@HINTS
{% hint 'warning' %}
The load function is deprecated from version 3.8.0 onwards and should no longer be used.
The load function is deprecated from version 3.8.0 onwards and is a no-op
from version 3.9.0 onwards. It should no longer be used, as it may be removed
in a future version of ArangoDB.
{% endhint %}

{% hint 'warning' %}
Expand All @@ -20,7 +22,8 @@ You should reference them via their names instead.
The name of the collection.

@RESTDESCRIPTION
Loads a collection into memory. Returns the collection on success.
Since ArangoDB version 3.9.0 this API does nothing. Previously it used to
load a collection into memory.

The request body object might optionally contain the following attribute:

Expand All @@ -29,7 +32,8 @@ The request body object might optionally contain the following attribute:
*false* may speed up loading a collection. The default value for
*count* is *true*.

On success an object with the following attributes is returned:
A call to this API returns an object with the following attributes for
compatibility reasons:

- *id*: The identifier of the collection.

Expand All @@ -43,7 +47,7 @@ On success an object with the following attributes is returned:

- *type*: The collection type. Valid types are:
- 2: document collection
- 3: edges collection
- 3: edge collection

- *isSystem*: If *true* then the collection is a system collection.

Expand Down
12 changes: 7 additions & 5 deletions Documentation/DocuBlocks/Rest/Collections/put_api_collection_unload.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@

@HINTS
{% hint 'warning' %}
The unload function is deprecated from version 3.8.0 onwards and should no longer be used.
The unload function is deprecated from version 3.8.0 onwards and is a no-op
from version 3.9.0 onwards. It should no longer be used, as it may be removed
in a future version of ArangoDB.
{% endhint %}

{% hint 'warning' %}
Expand All @@ -19,10 +21,10 @@ You should reference them via their names instead.
@RESTURLPARAM{collection-name,string,required}

@RESTDESCRIPTION
Removes a collection from memory. This call does not delete any documents.
You can use the collection afterwards; in which case it will be loaded into
memory, again. On success an object with the following attributes is
returned:
Since ArangoDB version 3.9.0 this API does nothing. Previously it used to
unload a collection from memory, while preserving all documents.
When calling the API an object with the following attributes is
returned for compatibility reasons:

- *id*: The identifier of the collection.

Expand Down
0