Skip to content

Commit 9728508

Browse files
authored
Merge pull request #60 from yangchangshun/improve-readme
Docs: update README.md
2 parents dc3edc1 + 1c4349d commit 9728508

1 file changed

Lines changed: 14 additions & 10 deletions

File tree

README.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -38,19 +38,23 @@ docker run -d -p 18888:8888 epsilla/vectordb
3838
```python
3939
from pyepsilla import vectordb
4040

41+
db_name = "MyDB"
42+
db_path = "/tmp/epsilla"
43+
table_name = "MyTable"
44+
4145
## 1.Connect to vectordb
4246
client = vectordb.Client(
4347
host='localhost',
4448
port='8888'
4549
)
4650

4751
## 2.Load and use a database
48-
client.load_db(db_name="MyDB", db_path="/tmp/epsilla")
49-
client.use_db(db_name="MyDB")
52+
client.load_db(db_name, db_path)
53+
client.use_db(db_name)
5054

5155
## 3.Create a table in the current database
5256
client.create_table(
53-
table_name="MyTable",
57+
table_name=table_name,
5458
table_fields=[
5559
{"name": "ID", "dataType": "INT", "primaryKey": True},
5660
{"name": "Doc", "dataType": "STRING"},
@@ -60,7 +64,7 @@ client.create_table(
6064

6165
## 4.Insert records
6266
client.insert(
63-
table_name="MyTable",
67+
table_name=table_name,
6468
records=[
6569
{"ID": 1, "Doc": "Berlin", "Embedding": [0.05, 0.61, 0.76, 0.74]},
6670
{"ID": 2, "Doc": "London", "Embedding": [0.19, 0.81, 0.75, 0.11]},
@@ -72,7 +76,7 @@ client.insert(
7276

7377
## 5.Search with specific response field
7478
status_code, response = client.query(
75-
table_name="MyTable",
79+
table_name=table_name,
7680
query_field="Embedding",
7781
query_vector=[0.35, 0.55, 0.47, 0.94],
7882
response_fields = ["Doc"],
@@ -82,24 +86,24 @@ print(response)
8286

8387
## 6.Search without specific response field, then it will return all fields
8488
status_code, response = client.query(
85-
table_name="MyTable",
89+
table_name=table_name,
8690
query_field="Embedding",
8791
query_vector=[0.35, 0.55, 0.47, 0.94],
8892
limit=2
8993
)
9094
print(response)
9195

9296
## 7.Delete records by primary_keys (and filter)
93-
status_code, response = client.delete(table_name="MyTable", primary_keys=[3, 4])
94-
status_code, response = client.delete(table_name="MyTable", filter="Doc <> 'San Francisco'")
97+
status_code, response = client.delete(table_name=table_name, primary_keys=[3, 4])
98+
status_code, response = client.delete(table_name=table_name, filter="Doc <> 'San Francisco'")
9599
print(response)
96100

97101

98102
## 8.Drop a table
99-
client.drop_table("MyTable")
103+
client.drop_table(table_name)
100104

101105
## 9.Unload a database from memory
102-
client.unload_db("MyDB")
106+
client.unload_db(db_name)
103107
```
104108

105109

0 commit comments

Comments
 (0)