Skip to content

Docs: add pointers from api-reference to sql docs.#11548

Merged
gianm merged 1 commit intoapache:masterfrom
gianm:docs-api-sql-pointers
Aug 11, 2021
Merged

Docs: add pointers from api-reference to sql docs.#11548
gianm merged 1 commit intoapache:masterfrom
gianm:docs-api-sql-pointers

Conversation

@gianm
Copy link
Contributor

@gianm gianm commented Aug 4, 2021

Giving people a little push towards using system tables when they can. (They're easier to use than the JSON APIs and more flexible)

Copy link
Contributor

@paul-rogers paul-rogers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great. Very helpful.

> Note: Much of this information is available in a simpler, easier-to-use form through the Druid SQL
> [`INFORMATION_SCHEMA.TABLES`](../querying/sql.md#tables-table),
> [`INFORMATION_SCHEMA.COLUMNS`](../querying/sql.md#columns-table), and
> [`sys.segments`](../querying/sql.md#segments-table) tables.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Is there a reason why one would choose these APIs over what's available via Druid SQL or vice versa.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The reason lies in the words "Much of this information". Some info is only available in the JSON APIs. (I didn't go through and enumerate which specific info that is, though.)

Copy link

@sthetland sthetland left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@gianm gianm merged commit faebefe into apache:master Aug 11, 2021
@clintropolis clintropolis added this to the 0.22.0 milestone Aug 12, 2021
@gianm gianm deleted the docs-api-sql-pointers branch September 23, 2022 19:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants