liveBook · Manning

Describe

As explained in ScyllaDB in Action

The DESCRIBE command is a Cassandra-compatible database shell command that displays the schema definition and configuration of a database object.

DESCRIBE is a cqlsh command for inspecting a table’s schema. Applied to authors, it prints the complete CREATE TABLE statement, including fields and explicit table settings. section 6.1.1 section 6.6

cqlsh:reviews> DESCRIBE authors;

CREATE TABLE reviews.authors (
    id timeuuid PRIMARY KEY,
    bio text,
    image image,
    name text
)...

Run DESCRIBE authors; the resulting CQL shows the reviews.authors table definition, including its timeuuid primary key and column types. section 6.1.1

Use DESCRIBE when you need to:

  • Refresh your memory about the columns available for an INSERT or UPDATE. section 6.1.1
  • Check the primary key required to store a row. section 6.1.1
  • Inspect table settings that are otherwise easy to overlook. section 6.1.1

How ScyllaDB in Action covers it

How deep it goes
Explains table-level schema output and settings, but does not detail command options beyond supplying a table.
Examples
Shows DESCRIBE authors producing the reviews.authors CREATE TABLE definition.
What it assumes
Assumes familiarity with cqlsh, tables, and basic INSERT statements.
What you can do after
Operate cqlsh to inspect fields, primary keys, and settings before constructing writes.
How it connects
Connects table schemas with CREATE TABLE statements, primary keys, INSERT statements, and UPDATE statements.

Also explained in

Compare how 2 books explain describe →

Related concepts

This explainer was generated by Manning's knowledge graph from the text of ScyllaDB in Action. The section links point to the parts of the book it draws on.