tarantool / tarantool/doc

SHOW CREATE TABLE statement

Open
#3,441 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

sql
Dominant language
CSS
Stars
15
Forks
49
Avg merge
1d 13h
Merged PRs (30d)
3

Description

Statement can be used to obtain a description of a space in the form of
a corresponding CREATE TABLE and CREATE INDEX statements. Result
will be in form of set of statements and set of found errors. If errors
were not detected, set of the statements should be enough to completely
serialize space definition.

There is two types of SHOW CREATE TABLE statement:

  1. Get a description of a single space:
SHOW CREATE TABLE table_name;

This statement can be used to obtain a description of a space in the
form of the corresponding CREATE TABLE and CREATE INDEX statements.
The result will be in the form of a set of statements and a set of found
errors. If no errors are found, the set of statements should be
sufficient to fully serialize the space definition. Otherwise, it will
certainly not be a complete space definition, and a CREATE TABLE
statement is generally not guaranteed to be syntactically correct.

  1. Get descriptions of all available non-system spaces:
SHOW CREATE TABLE;

This statement returns descriptions for each available non-system space
in the form described above.
Requested by @ImeevMA in https://github.com/tarantool/tarantool/commit/5ab5ce2a669526c64de52b8e7eab9975b57941a5.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No file, test, or entry point is named. Start by locating the Tarantool SQL statement reference in the documentation and identify where SHOW CREATE TABLE belongs. Document both single-space and all-space forms, including the returned CREATE TABLE and CREATE INDEX statements and error behavior described in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
sql
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.