색인

저장된 컬렉션에 색인을 추가, 조회, 삭제하는 방법을 설명합니다.

생성

색인은 DocumentDB.create_index 함수를 통해 생성할 수 있습니다. 옵션에 대한 자세한 내용은 스키마를 통해 확인할 수 있습니다.

from aeca import DocumentDB
 
doc_db = DocumentDB(channel)
 
collection_name = "example"
doc_db.create_index(
    collection_name, index_name="sk_author", fields=["author"],
    unique=False, index_type="kSecondaryKey", options=None
)

조회

색인은 DocumentDB.get_index 함수를 통해 조회할 수 있습니다.

doc_db.get_index(collection_name, "sk_author")
실행 결과
{'success': True,
 'message': '',
 'profile': {'duration': {'query': 0, 'serialization': 0, 'unit': 'us'}},
 'data': [{'collection_name': 'first_collection',
   'indexes': {'index_id': 2,
    'index_name': 'sk_author',
    'fields': ['author'],
    'unique': False,
    'index_type': 'kSecondaryKey',
    'status': 'kEnabled',
    'options': {}},
   'statistics': {'index_id': 2,
    'index_name': '',
    'approximated_size': 0,
    'num_docs': 0,
    'accessed': 0,
    'added': 0,
    'updated': 0,
    'deleted': 0,
    'merged': 0,
    'accessed_at': 0,
    'added_at': 0,
    'updated_at': 0,
    'deleted_at': 0,
    'merged_at': 0}}]}

편집

색인은 DocumentDB.rename_index 함수를 통해 이름을 변경할 수 있습니다.

doc_db.rename_index(collection_name, "sk_oldname", "sk_newname")

삭제

색인은 DocumentDB.drop_index 함수를 통해 삭제할 수 있습니다.

doc_db.drop_index(collection_name, "sk_author")