Skip to main content

Command → SDK map

Everything you can type as a DSL command (in the CLI) has a matching method call in each client library. They talk to the exact same server and do the exact same thing — the CLI is just handy for exploring, and the SDKs are how you build.

This page is the Rosetta Stone: find a command, see its equivalent in your language. Pick your language once with the tabs below and it stays selected across the whole page.

note

Signatures here are simplified to show the shape of each call. For full, runnable examples (imports, request objects, error handling), follow each command's Stores operation page and choose the Database engine tab.

One operation, every language

The same "create a store" operation, side by side:

CREATESTORE my_store DIMENSION 128

Full command map

Server & system

CommandPython
PINGclient.ping()
INFO SERVERclient.info_server()
LIST CONNECTED CLIENTSclient.list_clients()

Store management

CommandPython
LIST STORESclient.list_stores()
GETSTORE my_storeclient.get_store("my_store")
CREATESTORE my_store DIMENSION 128client.create_store("my_store", 128)
DROPSTORE my_storeclient.drop_store("my_store")

Data operations

CommandPython
SET doc1 [0.25,0.88] WITH {...} IN my_storeclient.set("my_store", "doc1", [0.25, 0.88], {"category": "news"})
DELKEY doc1 IN my_storeclient.delete_key("my_store", "doc1")
DELPRED (category='archive') IN my_storeclient.delete_predicate("my_store", "category='archive'")

Query & retrieval

CommandPython
GETSIMN 3 WITH [...] USING cosine IN my_storeclient.get_sim_n("my_store", [0.25, 0.88], 3, "cosine", predicate="lang='en'")
GETKEY doc1 IN my_storeclient.get_key("my_store", "doc1")
GETPRED (lang='en') IN my_storeclient.get_by_predicate("my_store", "lang='en'")

Index management

CommandPython
CREATEPREDINDEX (category) IN my_storeclient.create_predicate_index("my_store", "category")
DROPPREDINDEX (category) IN my_storeclient.drop_predicate_index("my_store", "category")
CREATENONLINEARALGORITHMINDEX (hnsw) IN my_storeclient.create_non_linear_algorithm_index("my_store", NonLinearIndex(hnsw=HNSWConfig()))
DROPNONLINEARALGORITHMINDEX (hnsw) IN my_storeclient.drop_non_linear_algorithm_index("my_store", "hnsw")

Next steps