Zvec Logo

Inspect a Collection

Once you've opened a collection, you can inspect its structure, configuration, and runtime state to better understand how it's organized and performing. This is especially helpful during development, debugging, or system monitoring.


Quick Reference

PropertyDescription
Collection.schemaCollection structure and field definitions (e.g., vector dimensions, data types)
Collection.statsRuntime metrics such as document count and index completeness
Collection.optionRuntime settings (e.g., read-only mode, memory mapping)
Collection.pathFilesystem path to the collection directory

Collection Schema

To view the schema:

print(collection.schema)


Collection Statistics

The stats property provides real-time operational insights:

print(collection.stats)


Collection Options

Runtime behavior is governed by the options used when opening the collection:

print(collection.option)


Collection Path

The path property returns the on-disk location of the collection:

print(collection.path)