Managed Databases

Browse schemas, tables, and keys

Changed on

Walk the database one level at a time with path.

  • PostgreSQL, MySQL, ClickHouse: [] lists schemas, [schema] lists its tables, [schema, table] returns a page of rows. Page with limit and next_cursor.
  • Valkey: [] lists keys (filter with match, for example user:*), [key] returns the key's value with its type and TTL in meta.
  • Kafka: [] lists topics, [topic] returns the newest messages of every partition, [topic, partition] the newest of one partition. limit sets how many (default 20, up to 200).

A response has kind: nodes (a list in nodes) or kind: rows (columns and rows).

post/api/v1/databases/{database_id}/browse

Request

  • Base URL
    https://api.rafftechnologies.com
  • URL
    https://api.rafftechnologies.com/api/v1/databases/{database_id}/browse
  • Auth
    API key in header X-API-Key

Path parameters

database_idstring required

Database ID (UUID) or short id (the database_id field, e.g. a1b2c3d4)

Request body

pathstring[]

[], [schema], or [schema, table]; for Valkey [] or [key]; for Kafka [], [topic], or [topic, partition]

cursorstring

next_cursor from the previous page

matchstring

Valkey key pattern

limitinteger

Items or rows per page

Example request

{
  "path": [
    "public",
    "users"
  ],
  "match": "user:*"
}

Response

One level of the database

successboolean
kind'nodes' | 'rows'
columnsstring[]
next_cursorstring

Pass as cursor for the next page; empty on the last page

metaobject

Valkey key type and TTL

Changes