Skip to content

Automate the testing of SQL commands #7067

Open
@jseldess

Description

@jseldess

Jesse Seldess commented:

We have SQL commands throughout almost all of our tutorials and how-tos (e.g., Learn CockroachDB SQL, SQL Tuning with EXPLAIN, and in examples throughout our SQL reference docs (e.g., CREATE INDEX. Just as with driver/ORM code samples, it'd be ideal to automate the testing of our SQL commands to ensure our docs are accurate and copy/paste-able for users.

Possible actions:

  • [ ) Use a consistent dataset (built-in to cockroach) across SQL docs. @ericharmeling and @rmloveland made some initial progress here using the movr dataset built into [cockroach demo](https://www.cockroachlabs.com/docs/stable/cockroach-demo.html] on a subset of SQL docs. We should verify that's the approach we want.
  • [ ) Automate the testing of the code on a regular basis via CI. Approach may be the same or different to https://github.com/Automate the testing of driver/ORM code #7066.

Jira Issue: DOC-485

Metadata

Metadata

Assignees

No one assigned

    Labels

    C-general-adminP-1High priority; must be done this release

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions