update query/get api/query comments and test (#263)

* update query/get api/query comments and test Signed-off-by: ryjiang <[email protected]> * update comment Signed-off-by: ryjiang <[email protected]> --------- Signed-off-by: ryjiang <[email protected]>
milvus-io · Dec 15, 2023 · 64ddccb · 64ddccb
1 parent dd8e4c3
commit 64ddccb
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 25 deletions.
diff --git a/milvus/grpc/Data.ts b/milvus/grpc/Data.ts
@@ -108,7 +108,7 @@ export class Data extends Collection {
    * ```
    *  new milvusClient(MILUVS_ADDRESS).insert({
    *    collection_name: COLLECTION_NAME,
-   *    fields_data: [{
+   *    data: [{
    *      vector_field: [1,2,2,4],
    *      scalar_field: 1
    *    }]
@@ -711,11 +711,11 @@ export class Data extends Collection {
    *  | Property | Type  | Description |
    *  | :--- | :-- | :-- |
    *  | collection_name | String | Collection name |
-   *  | expr or filter | String | Scalar field filter expression |
+   *  | ids | String[] | ids to get |
+   *  | expr or filter | String | Scalar field filter expression, filter > expr > ids |
    *  | partitions_names(optional) | String[] | Array of partition names |
    *  | output_fields | String[] | Vector or scalar field to be returned |
    *  | timeout? | number | An optional duration of time in millisecond to allow for the RPC. If it is set to undefined, the client keeps waiting until the server responds or error occurs. Default is undefined |
-
    *  | params | {key: value}[] | An optional key pair json array
    *
    * @returns
@@ -730,7 +730,7 @@ export class Data extends Collection {
    * ```
    *  new milvusClient(MILUVS_ADDRESS).query({
    *    collection_name: 'my_collection',
-   *    expr: "age in [1,2,3,4,5,6,7,8]",
+   *    filter: "age in [1,2,3,4,5,6,7,8]",
    *    output_fields: ["age"],
    *  });
    * ```
@@ -749,8 +749,23 @@ export class Data extends Collection {
       offset = { offset: data.offset };
     }
 
-    // filter > expr or empty
-    data.expr = data.filter || data.expr || '';
+    // id in expression
+    let primaryKeyInIdsExpression = '';
+
+    // if we have ids
+    if (data.ids && data.ids.length > 0) {
+      const pkField = await this.getPkFieldName(data);
+      const pkFieldType = await this.getPkFieldType(data);
+
+      // generate expr by different type of pk
+      primaryKeyInIdsExpression =
+        DataTypeMap[pkFieldType] === DataType.VarChar
+          ? `${pkField} in ["${data.ids.join('","')}"]`
+          : `${pkField} in [${data.ids.join(',')}]`;
+    }
+
+    // filter > expr or empty > ids
+    data.expr = data.filter || data.expr || primaryKeyInIdsExpression;
 
     // Execute the query and get the results
     const promise: QueryRes = await promisify(
@@ -852,25 +867,7 @@ export class Data extends Collection {
    * ```
    */
   async get(data: GetReq): Promise<QueryResults> {
-    checkCollectionName(data);
-
-    const pkField = await this.getPkFieldName(data);
-
-    if (!data.ids || data.ids.length === 0) {
-      throw new Error(ERROR_REASONS.IDS_REQUIRED);
-    }
-
-    const pkFieldType = await this.getPkFieldType(data);
-
-    // generate expr by different type of pk
-    const expr =
-      DataTypeMap[pkFieldType] === DataType.VarChar
-        ? `${pkField} in ["${data.ids.join('","')}"]`
-        : `${pkField} in [${data.ids.join(',')}]`;
-
-    // build query req
-    const req = { ...data, expr };
-    return this.query(req);
+    return this.query(data);
   }
 
   /**

diff --git a/milvus/types/Data.ts b/milvus/types/Data.ts
@@ -308,6 +308,7 @@ export interface SearchRes extends resStatusResponse {
 export interface QueryReq extends collectionNameReq {
   output_fields?: string[];
   partition_names?: string[];
+  ids?: string[] | number[];
   expr?: string;
   filter?: string;
   offset?: number;

diff --git a/test/grpc/Data.spec.ts b/test/grpc/Data.spec.ts
@@ -520,6 +520,15 @@ describe(`Data.API`, () => {
     expect(res.data.length).toEqual(0);
   });
 
+  it(`query by ids success`, async () => {
+    const query = await milvusClient.query({
+      collection_name: COLLECTION_NAME,
+      ids: ['1', '2', '3'],
+    });
+
+    expect(query.status.error_code).toEqual(ErrorCode.SUCCESS);
+  });
+
   it(`delete by ids should success`, async () => {
     const res = await milvusClient.delete({
       collection_name: COLLECTION_NAME,