Skip to content

Commit 57880b1

Browse files
AnthonyTsu1984github-actions[bot]
authored andcommitted
Apply automatic changes
1 parent 2dbd195 commit 57880b1

File tree

719 files changed

+9877
-7614
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

719 files changed

+9877
-7614
lines changed

reference/api/go/go/v1/v1-Collection/v1-Collection-Columns.md

Lines changed: 59 additions & 56 deletions
Large diffs are not rendered by default.

reference/api/go/go/v1/v1-Collection/v1-Collection-CreateCollection.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ title: "CreateCollection() | Go | v1"
33
slug: /go/v1-Collection-CreateCollection
44
sidebar_label: "CreateCollection()"
55
beta: NEAR DEPRECATE
6+
added_since: FALSE
7+
last_modified: FALSE
8+
deprecate_since: FALSE
69
notebook: FALSE
710
description: "This method creates a collection with the specified schema. | Go | v1"
811
type: origin
@@ -39,7 +42,7 @@ func (c *GrpcClient) CreateCollection(ctx context.Context, collSchema *entity.Sc
3942
<tr>
4043
<td><p><code>collSchema</code></p></td>
4144
<td><p>Schema of the collection to create.</p></td>
42-
<td><p><code>*entity.Schema</code></p></td>
45+
<td><p><code>*&#91;entity.Schema</code>](./v1-Collection-CreateCollection#entityschema)</p></td>
4346
</tr>
4447
<tr>
4548
<td><p><code>shardNum</code></p></td>
@@ -49,7 +52,7 @@ func (c *GrpcClient) CreateCollection(ctx context.Context, collSchema *entity.Sc
4952
<tr>
5053
<td><p><code>opts</code></p></td>
5154
<td><p>Extra options for the current request.</p><p>This parameter is optional. You can add multiple <code>CreateCollectionOption</code> in the request.</p></td>
52-
<td><p><code>...entity.CreateCollectionOption</code></p></td>
55+
<td><p><code>...&#91;entity.CreateCollectionOption</code>](./v1-Collection-CreateCollection#entitycreatecollectionoption)</p></td>
5356
</tr>
5457
</table>
5558

@@ -86,12 +89,12 @@ schema := entity.NewSchema().
8689
<td><p>Whether the primary field is automatically generated upon data insertions.</p></td>
8790
</tr>
8891
<tr>
89-
<td><p><code>WithField(f *entity.Field)</code></p></td>
92+
<td><p><code>WithField(f *&#91;entity.Field&#93;(./v1-Collection-CreateCollection#entityfield))</code></p></td>
9093
<td><p>A field in the collection to create.</p><p>Call the method multiple types to add more fields.</p></td>
9194
</tr>
9295
<tr>
9396
<td><p><code>WithDynamicFieldEnabled(dynamicEnabled bool)</code></p></td>
94-
<td><p>Whether to enable the dynamic field for non-schema-defined fields.</p><p>Once enabled, non-schema-defined fields and their values are saved in the reserved JSON field named <strong>$meta</strong>.</p><p>As an alternative, you can use <code>entity.WithEnableDynamicSchema()</code> to create an <code>entity.CreateCollectionOption</code> instead.</p><p>If you assign different values to this method and <code>entity.WithEnableDynamicSchema()</code>, the one set to <code>true</code> takes precedence.</p></td>
97+
<td><p>Whether to enable the dynamic field for non-schema-defined fields.</p><p>Once enabled, non-schema-defined fields and their values are saved in the reserved JSON field named <strong>&#36;meta</strong>.</p><p>As an alternative, you can use <code>entity.WithEnableDynamicSchema()</code> to create an <code>entity.CreateCollectionOption</code> instead.</p><p>If you assign different values to this method and <code>entity.WithEnableDynamicSchema()</code>, the one set to <code>true</code> takes precedence.</p></td>
9598
</tr>
9699
</table>
97100

@@ -136,7 +139,7 @@ field := entity.NewField().
136139
<td><p>Whether the primary field value is automatically generated upon data insertions.</p><p>If this value is different from the one specified in <code>entity.Schema</code>, this value takes precedence.</p></td>
137140
</tr>
138141
<tr>
139-
<td><p><code>WithDataType(dataType entity.FieldType)</code></p></td>
142+
<td><p><code>WithDataType(dataType &#91;entity.FieldType&#93;(./v1-Collection-CreateCollection#entityfieldtype))</code></p></td>
140143
<td><p>The data type of the field.</p></td>
141144
</tr>
142145
<tr>
@@ -152,7 +155,7 @@ field := entity.NewField().
152155
<td><p>The maximum number of elements of an ARRAY field.</p><p>This only applies when you set <code>dataType</code> to <code>FieldTypeArray</code> in <code>WithDataType()</code>.</p></td>
153156
</tr>
154157
<tr>
155-
<td><p><code>WithElementType(eleType entity.FieldType)</code></p></td>
158+
<td><p><code>WithElementType(eleType &#91;entity.FieldType&#93;(./v1-Collection-CreateCollection#entityfieldtype))</code></p></td>
156159
<td><p>The maximum number of elements of an ARRAY field.</p><p>This only applies when you set <code>dataType</code> to <code>FieldTypeArray</code> in <code>WithDataType()</code>.</p></td>
157160
</tr>
158161
<tr>
@@ -229,7 +232,7 @@ You can add extra collection settings to the `CreateCollection()` request using
229232
</tr>
230233
<tr>
231234
<td><p><code>WithEnableDynamicSchema(enable bool)</code></p></td>
232-
<td><p>Whether to enable the dynamic field for non-schema-defined fields.</p><p>Once enabled, non-schema-defined fields and their values are saved in the reserved JSON field named <strong>$meta</strong>.</p><p>As an alternative, you can append <code>WithDynamicFieldEnable(true)</code> to the <code>entity.NewSchema()</code> request instead.</p><p>If you assign different values to this method and <code>entity.WithDynamicFieldEnable()</code>, the one set to <code>true</code> takes precedence.</p></td>
235+
<td><p>Whether to enable the dynamic field for non-schema-defined fields.</p><p>Once enabled, non-schema-defined fields and their values are saved in the reserved JSON field named <strong>&#36;meta</strong>.</p><p>As an alternative, you can append <code>WithDynamicFieldEnable(true)</code> to the <code>entity.NewSchema()</code> request instead.</p><p>If you assign different values to this method and <code>entity.WithDynamicFieldEnable()</code>, the one set to <code>true</code> takes precedence.</p></td>
233236
</tr>
234237
<tr>
235238
<td><p><code>WithPartitionNum(partitionNums int64)</code></p></td>

reference/api/go/go/v1/v1-Collection/v1-Collection-Delete.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ title: "Delete() | Go | v1"
33
slug: /go/v1-Collection-Delete
44
sidebar_label: "Delete()"
55
beta: NEAR DEPRECATE
6+
added_since: FALSE
7+
last_modified: FALSE
8+
deprecate_since: FALSE
69
notebook: FALSE
710
description: "This method deletes the entities that match the specified filtering conditions from a collection. | Go | v1"
811
type: origin

reference/api/go/go/v1/v1-Collection/v1-Collection-DeleteByPks.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ title: "DeleteByPks() | Go | v1"
33
slug: /go/v1-Collection-DeleteByPks
44
sidebar_label: "DeleteByPks()"
55
beta: NEAR DEPRECATE
6+
added_since: FALSE
7+
last_modified: FALSE
8+
deprecate_since: FALSE
69
notebook: FALSE
710
description: "This method deletes the specified entities from a collection. | Go | v1"
811
type: origin
@@ -49,7 +52,7 @@ func (c *GrpcClient) DeleteByPks(ctx context.Context, collName string, partition
4952
<tr>
5053
<td><p><code>ids</code></p></td>
5154
<td><p>IDs of the entities to delete.</p></td>
52-
<td><p><code>entity.Column</code></p></td>
55+
<td><p><a href="./v1-Collection-Columns"><code>entity.Column</code></a></p></td>
5356
</tr>
5457
</table>
5558

reference/api/go/go/v1/v1-Collection/v1-Collection-DescribeCollection.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ title: "DescribeCollection() | Go | v1"
33
slug: /go/v1-Collection-DescribeCollection
44
sidebar_label: "DescribeCollection()"
55
beta: NEAR DEPRECATE
6+
added_since: FALSE
7+
last_modified: FALSE
8+
deprecate_since: FALSE
69
notebook: FALSE
710
description: "This method returns the details of a specific collection. | Go | v1"
811
type: origin

reference/api/go/go/v1/v1-Collection/v1-Collection-DropCollection.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ title: "DropCollection() | Go | v1"
33
slug: /go/v1-Collection-DropCollection
44
sidebar_label: "DropCollection()"
55
beta: NEAR DEPRECATE
6+
added_since: FALSE
7+
last_modified: FALSE
8+
deprecate_since: FALSE
69
notebook: FALSE
710
description: "This method drops the specified collection and the entities within. | Go | v1"
811
type: origin

reference/api/go/go/v1/v1-Collection/v1-Collection-Flush.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ title: "Flush() | Go | v1"
33
slug: /go/v1-Collection-Flush
44
sidebar_label: "Flush()"
55
beta: NEAR DEPRECATE
6+
added_since: FALSE
7+
last_modified: FALSE
8+
deprecate_since: FALSE
69
notebook: FALSE
710
description: "This method synchronously stores entities from memory to storage and returns when the operations on every segments are complete. | Go | v1"
811
type: origin

reference/api/go/go/v1/v1-Collection/v1-Collection-Get.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ title: "Get() | Go | v1"
33
slug: /go/v1-Collection-Get
44
sidebar_label: "Get()"
55
beta: NEAR DEPRECATE
6+
added_since: FALSE
7+
last_modified: FALSE
8+
deprecate_since: FALSE
69
notebook: FALSE
710
description: "This method gets entities by their IDs. | Go | v1"
811
type: origin
@@ -42,12 +45,12 @@ func (c *GrpcClient) Get(ctx context.Context, collectionName string, ids entity.
4245
<tr>
4346
<td><p><code>ids</code></p></td>
4447
<td><p>Boolean expression for metadata filtering.</p><p>For details, refer to <a href="https://milvus.io/docs/boolean.md">Scalar Filtering Rules</a>.</p></td>
45-
<td><p><code>entity.Column</code></p></td>
48+
<td><p><a href="./v1-Collection-Insert#entitycolumn"><code>entity.Column</code></a></p></td>
4649
</tr>
4750
<tr>
4851
<td><p><code>opts</code></p></td>
4952
<td><p>Extra query options.</p><p>You can add multiple <code>client.GetOption</code> instances.</p></td>
50-
<td><p><code>...client.GetOption</code></p></td>
53+
<td><p><code>...&#91;client.GetOption</code>](./v1-Collection-Get#clientgetoption)</p></td>
5154
</tr>
5255
</table>
5356

@@ -70,7 +73,7 @@ You can add extra settings to the `Get()` request using the following methods.
7073
</tr>
7174
</table>
7275

73-
A `client.ResultSet`, which is a slice of `entity.Column`.
76+
A `client.ResultSet`, which is a slice of [`entity.Column`](./v1-Collection-Insert#entitycolumn).
7477

7578
### client.ResultSet{#clientresultset}
7679

reference/api/go/go/v1/v1-Collection/v1-Collection-GetLoadState.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ title: "GetLoadState() | Go | v1"
33
slug: /go/v1-Collection-GetLoadState
44
sidebar_label: "GetLoadState()"
55
beta: NEAR DEPRECATE
6+
added_since: FALSE
7+
last_modified: FALSE
8+
deprecate_since: FALSE
69
notebook: FALSE
710
description: "This method displays the load status of a specific collection or its partitions. | Go | v1"
811
type: origin
@@ -42,7 +45,7 @@ func (c *GrpcClient) GetLoadState(ctx context.Context, collName string, partitio
4245
<tr>
4346
<td><p><code>partitionNames</code></p></td>
4447
<td><p>List of partition names. </p><p>If left empty, all partitions are involved in this operation. Otherwise, only the specified partitions are involved.</p></td>
45-
<td><p><code>[]string</code></p></td>
48+
<td><p><code>&#91;&#93;string</code></p></td>
4649
</tr>
4750
</table>
4851

reference/api/go/go/v1/v1-Collection/v1-Collection-Insert.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ title: "Insert() | Go | v1"
33
slug: /go/v1-Collection-Insert
44
sidebar_label: "Insert()"
55
beta: NEAR DEPRECATE
6+
added_since: FALSE
7+
last_modified: FALSE
8+
deprecate_since: FALSE
69
notebook: FALSE
710
description: "This method inserts entities organized in columns into the specified collection. | Go | v1"
811
type: origin
@@ -49,7 +52,7 @@ func (c *GrpcClient) Insert(ctx context.Context, collName string, partitionName
4952
<tr>
5053
<td><p><code>columns</code></p></td>
5154
<td><p>Data to insert into the specified collection.</p><p>You should include the data for all the fields defined in the collection schema.</p></td>
52-
<td><p><code>...entity.Column</code></p></td>
55+
<td><p><code>...&#91;entity.Column</code>](./v1-Collection-Insert#entitycolumn)</p></td>
5356
</tr>
5457
</table>
5558

@@ -85,7 +88,7 @@ type Column interface {
8588
</tr>
8689
<tr>
8790
<td><p><code>Type()</code></p></td>
88-
<td><p><code>entity.FieldType</code></p></td>
91+
<td><p><a href="./v1-Collection-CreateCollection#entityfieldtype"><code>entity.FieldType</code></a></p></td>
8992
<td><p>Return the column data type.</p></td>
9093
</tr>
9194
<tr>
@@ -99,13 +102,13 @@ type Column interface {
99102
<td><p>Return a column that contains the specified rows from the column.</p></td>
100103
</tr>
101104
<tr>
102-
<td><p><code>AppendValue(interface{})</code></p></td>
105+
<td><p><code>AppendValue(interface&#123;&#125;)</code></p></td>
103106
<td><p><code>error</code></p></td>
104107
<td><p>Append values to the column.</p></td>
105108
</tr>
106109
<tr>
107110
<td><p><code>Get(int)</code></p></td>
108-
<td><p><code>interface{}, error</code></p></td>
111+
<td><p><code>interface&#123;&#125;, error</code></p></td>
109112
<td><p>Return the value at the specified ID in the column or an error.</p></td>
110113
</tr>
111114
<tr>
@@ -134,7 +137,7 @@ For details on the struct types that implement the above method signatures, refe
134137

135138
## Return{#return}
136139

137-
`entity.Column`
140+
[`entity.Column`](./v1-Collection-Insert#entitycolumn)
138141

139142
## Errors{#errors}
140143

0 commit comments

Comments
 (0)