List table metadata (HTTP)

For details about additional languages, see:

Gets information about the tables in a keyspace.

Ready to write code? See the examples for this method to get started.

Result

The status.tables field in the response describes each table.

Example response:

{
  "status": {
    "tables": [
      {
        "name": "customers",
        "definition": {
          "columns": {
            "order_date": {
              "type": "timestamp"
            },
            "preferences": {
              "type": "map",
              "keyType": "text",
              "valueType": "text"
            },
            "is_active": {
              "type": "boolean"
            },
            "user_id": {
              "type": "uuid"
            },
            "name": {
              "type": "text"
            },
            "login_attempts": {
              "type": "set",
              "valueType": "int"
            },
            "photo": {
              "type": "blob"
            },
            "salary": {
              "type": "decimal"
            },
            "order_id": {
              "type": "uuid"
            },
            "age": {
              "type": "int"
            },
            "tags": {
              "type": "list",
              "valueType": "text"
            }
          },
          "primaryKey": {
            "partitionBy": [
              "user_id"
            ],
            "partitionSort": {
              "order_id": 1,
              "order_date": -1
            }
          }
        }
      }
    ]
  }
}

Signature

Use the listTables command.

curl -sS -L -X POST "API_ENDPOINT/api/json/v1/KEYSPACE_NAME" \
--header "Token: APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
  "listTables": {
    "options": {
      "explain": true
    }
  }
}'

Parameters

Name Type Summary

Name	Type	Summary
`options.explain`	`true`	Must be `true` to return metadata about the tables. Otherwise, only the table names are returned.

options.explain

true

Must be true to return metadata about the tables. Otherwise, only the table names are returned.

Examples

The following examples demonstrate how to list table metadata.

List table metadata

curl -sS -L -X POST "API_ENDPOINT/api/json/v1/KEYSPACE_NAME" \
  --header "Token: APPLICATION_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "listTables": {
    "options": {
      "explain": true
    }
  }
}'

List table metadata (HTTP)

Result

Signature

Parameters

Examples

List table metadata

Was this helpful?

Give Feedback