github.com/milvus-io/milvus-sdk-go/v2@v2.4.1/docs/describe_collection.md (about)

     1  # Describe Collection
     2  
     3  API to get collection information.
     4  
     5  ## Parameters
     6  
     7  | Parameter    | Description                                                   | Type                     |
     8  | ------------ | ------------------------------------------------------------- | ------------------------ |
     9  | `ctx`        | Context to control API invocation process.                    | context.Context          |
    10  | `collName`   | Name of the collection to describe.                           | String                   |
    11  
    12  
    13  
    14  
    15  ## Response
    16  
    17  - `collection`: pointer of entity.Collection that represents the collection to describe.
    18  
    19  - `err`: error in the process (if any), possible errors are listed:
    20  
    21      - `ErrClientNotReady`, error that the client is not connected.
    22  
    23      - `ErrCollectionNotExists`, error that the collection with the specified name does not exist.
    24  
    25      - error that API invocation failed.
    26  
    27  ## Example
    28  
    29  ```go
    30  ctx := context.Background()
    31  // cli is a valid Client instance, assume test collection exists
    32  coll, err := cli.DescribeCollection(ctx, "TestCollection")
    33  // handles the error not nil
    34  ```