100B vectors @ 200ms p99

GET /v1/namespaces/:namespace/metadata

Returns metadata about a namespace.

Response

schema object

approx_logical_bytes integer

The approximate number of logical bytes in the namespace.

This is a coarse approximation and may change over time as turbopuffer's data representation evolves.


approx_row_count integer

The approximate number of rows in the namespace.


created_at string

The timestamp when the namespace was created, in ISO 8601 format.

Example: "2024-03-15T10:30:45Z"


updated_at string

The timestamp when the namespace was last modified by a write operation, in ISO 8601 format.

Example: "2024-04-16T09:27:32Z"


encryption object

Describes how the namespace is encrypted.

  • SSE (default): { "sse": true }
  • CMEK: { "cmek": { "key_name": "…" } }
  // GCP Example
  { "cmek":
    { "key_name": "projects/myproject/locations/us-central1/keyRings/EXAMPLE/cryptoKeys/KEYNAME" }
  }
  // AWS Example
  { "cmek":
    { "key_name": "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012" }
  }

index object

The state of the index for the namespace. Contains the following fields:

  • status (string): updating or up-to-date

  • unindexed_bytes (integer):

    The number of bytes in the namespace that are in the write-ahead log but have not yet been indexed. Note that unindexed data is still searched by queries (see consistency for details).

    Only present when status is updating.

Example

Billing

This request is billed as a query that returns zero rows.

Follow
Blog