Skip to content

Commit

Permalink
add doc for alias
Browse files Browse the repository at this point in the history
  • Loading branch information
zcdb committed May 7, 2024
1 parent 97148c6 commit c27503f
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# vscode
*.vscode
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Vearch System Introduction
use_op/op_cluster.rst
use_op/op_db.rst
use_op/op_space.rst
use_op/op_alias.rst
use_op/op_doc.rst

.. toctree::
Expand Down
34 changes: 34 additions & 0 deletions docs/source/use_op/op_alias.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
Alias operation
==================================

The alias can be a short string to facilitate identification and access of the corresponding space.

Usually the alias will replace the name of the Space to facilitate business switching and other scenarios.

http://master_server represents the master service, $db_name is the name of the created database, $space_name is the name of the created space

Create space alias
--------------------------------
::
curl -XPOST http://master_server/alias/$alias_name/dbs/$db_name/spaces/$space_name


Update space alias
--------------------------------
::
curl -XPUT http://master_server/alias/$alias_name/dbs/$db_name/spaces/$space_name


Get alias details
--------------------------------
::
curl -XGET http://master_server/alias/$alias_name

Delete space alias
--------------------------------
::
curl -XDELETE http://master_server/alias/$alias_name

0 comments on commit c27503f

Please sign in to comment.