milvus-io
/
milvus
mirror of https://github.com/milvus-io/milvus.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add a collection TTL doc (#19859) 

Signed-off-by: yun.zhang <yun.zhang@zilliz.com>

Signed-off-by: yun.zhang <yun.zhang@zilliz.com>
pull/19860/head
jaime 2022-10-18 14:09:26 +08:00 committed by GitHub
parent a1cdc55bcb
commit f8cb260931
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/user_guides/collection_ttl.md Normal file
View File

@ -0,0 +1,21 @@
# Illustration
Collection TTL(Time to Live ) is the expiration time attribute on the collection. The expired data will not be queried or searched and clean up with the GC mechanism.
# Manipulation
We provide a property of collection level to config TTL: `collection.ttl.seconds`.
There is a priority for the collection TTL configuration, attempting to get the `collection.ttl.seconds`
from the collection properties first . If the configuration does not exist within the properties,
then read `common.entityExpiration` from milvus.yaml, the collection TTL will not be set when the above steps fail.
## Set TTL for a new collection
The following example is set TTL to 15 seconds:
```python
collection = Collection(name=name,vschema=schema,properties={"collection.ttl.seconds": 15})
```
## Set TTL for an old collection
The following example is modifying TTL to 1800 seconds:
```python
collection.set_properties(properties={"collection.ttl.seconds": 1800})
```
The above examples use Python SDK . If you want to know more details, please refer to example.py.