You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: API_Reference/pymilvus/v2.4.x/MilvusClient/Collections/alter_collection_field.md
+1-60Lines changed: 1 addition & 60 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,65 +29,6 @@ alter_collection_field(
29
29
30
30
The field parameters to change. The properties not mentioned remains unchanged. Possible parameters vary with the field type.
31
31
32
-
-**is_primary** (*bool*) -
33
-
34
-
Whether the current field is the primary field in a collection.
35
-
36
-
<div class="admonition note">
37
-
38
-
<p><b>notes</b></p>
39
-
40
-
<ul>
41
-
<li><p>Each collection has only one primary field.</p></li>
42
-
<li><p>A primary field should be of either the <strong>DataType.INT64</strong> type or the <strong>DataType.VARCHAR</strong> type.</p></li>
43
-
</ul>
44
-
45
-
</div>
46
-
47
-
-**max_length** (*int*) -
48
-
49
-
The maximum byte length for strings allowed to be inserted. Note that multibyte characters (e.g., Unicode characters) may occupy more than one byte each, so ensure the byte length of inserted strings does not exceed the specified limit. Value range: [1, 65,535].
50
-
51
-
This is mandatory for a **DataType.VARCHAR** field.
52
-
53
-
-**element_type** (*str*) -
54
-
55
-
The data type of the elements in the field value.
56
-
57
-
This is mandatory for a **DataType.ARRAY** field.
58
-
59
-
-**max_capacity** (*int*) -
60
-
61
-
The number of elements in an Array field value.
62
-
63
-
This is mandatory for a **DataType.ARRAY** field.
64
-
65
-
-**dim** (*int*) -
66
-
67
-
The dimension of the vector embeddings. The value should be an integer greater than 1.
68
-
69
-
This is mandatory for a field of the **DataType.FLOAT_VECTOR**, **DataType.BINARY_VECTOR**, **DataType.FLOAT16_VECTOR**, or **DataType.BFLOAT16_VECTOR** type. If you use **DataType.SPARSE_FLOAT_VECTOR**, omit this parameter.
70
-
71
-
-**is_partition_key** (*bool*) -
72
-
73
-
Whether the current field serves as the partition key. Each collection can have one partition key.
74
-
75
-
This parameter is not applicable to Milvus Lite. For more information on Milvus Lite limits, refer to [Run Milvus Lite](https://milvus.io/docs/milvus_lite.md).
76
-
77
-
<divclass="admonition note">
78
-
79
-
<p><b>what is the partition key?</b></p>
80
-
81
-
<p>To facilitate partition-oriented multi-tenancy, you can set a field as the partition key field so that Milvus hashes the field values and distributes entities among the specified number of partitions accordingly.</p>
82
-
<p>When retrieving entities, ensure that the partition key field is used in the boolean expression to filter out entities of a specific field value.</p>
83
-
<p>For details, refer to <ahref="https://milvus.io/docs/use-partition-key">Use Partition Key</a> and <ahref="https://milvus.io/docs/multi_tenancy.md">Multi-tenancy</a>.</p>
84
-
85
-
</div>
86
-
87
-
-**is_clustering_key** (*bool*) -
88
-
89
-
Whether the current field serves as the clustering key. Each collection can have one partition key. You can also use the partition key as the clustering key. For details, refer to Clustering Compaction.
90
-
91
32
-**mmap_enabled** (*bool*) -
92
33
93
34
Whether Milvus maps the field data into memory instead of fully loading it. For details settings, refer to MMap-enabled Data Storage.
0 commit comments