Skip to content

docs: fix data management section #801

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
JoanFM merged 1 commit into from
Nov 16, 2022
Merged

docs: fix data management section #801

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
14 changes: 7 additions & 7 deletions docs/fundamentals/cloud-support/data.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
(data-management)=
## Data Management
# Data Management
Jina AI Cloud offers data management of DocumentArrays, using either the console or the DocArray Python API.

### Web Console
## Web Console
In order to use the web console to manage your storage, you need to log in at [cloud.jina.ai](https://cloud.jina.ai).
Then, head to the [User Storage page](https://cloud.jina.ai/user/storage).

Expand All @@ -14,11 +14,11 @@ Your DocumentArrays should appear in the data section inside the storage page:
You can delete, download, view, or change the visibility of your DocumentArray objects using the web console.


### Python API
## Python API
DocArray offers a Python API for data management.
Once you've successfully {ref}`logged in<login>`, you can start using `DocumentArray` methods to manage data.

#### Push (create/update):
### Push (create/update):
You can push in-memory `DocumentArray` objects using the {meth}`~docarray.array.mixins.io.pushpull.PushPullMixin.push` method:
```python
from docarray import DocumentArray
Expand All @@ -28,15 +28,15 @@ da.push('my_da', show_progress=True)
```
This will create a DocumentArray object in the cloud or update it if it already exists.

#### Pull (Read):
### Pull (Read):
You can download a DocumentArray stored in the cloud using the {meth}`~docarray.array.mixins.io.pushpull.PushPullMixin.pull` method:
```python
from docarray import DocumentArray

my_da = DocumentArray('my_da')
```

#### List
### List
You can list all `DocumentArray` objects stored in the cloud using the {meth}`~docarray.array.mixins.io.pushpull.PushPullMixin.cloud_list` method:
```python
DocumentArray.cloud_list(show_table=True)
Expand All @@ -56,7 +56,7 @@ DocumentArray.cloud_list(show_table=True)
Use the `show_table` parameter to show summary information about DocumentArrays in the cloud.
```

#### Delete
### Delete

You can delete DocumentArray objects in the cloud using the method {meth}`~docarray.array.mixins.io.pushpull.PushPullMixin.cloud_delete`:
```python
Expand Down