Skip to content

Document create/drop catalog#19612

Merged
mosabua merged 1 commit intotrinodb:masterfrom
nineinchnick:dynamic-catalogs-docs
Nov 6, 2023
Merged

Document create/drop catalog#19612
mosabua merged 1 commit intotrinodb:masterfrom
nineinchnick:dynamic-catalogs-docs

Conversation

@nineinchnick
Copy link
Member

@nineinchnick nineinchnick commented Nov 2, 2023

Description

Document create/drop catalog with a lot of warnings about known issues.

This adds 3 pages:

  • CREATE CATALOG
  • DROP CATALOG
  • Catalog management properties

There are more existing and undocumented catalog management properties, like catalog.config-dir, that can be added to the new properties page later.

I decided to repeat the same warnings on multiple pages, since they're very important.

Additional context and related issues

Release notes

(x) This is not user-visible or is docs only, and no release notes are required.
( ) Release notes are required. Please propose a release note for me.
( ) Release notes are required, with the following suggested text:

@cla-bot cla-bot bot added the cla-signed label Nov 2, 2023
@nineinchnick nineinchnick requested review from dain and mosabua November 2, 2023 11:15
@github-actions github-actions bot added the docs label Nov 2, 2023
@nineinchnick
Copy link
Member Author

Some screenshots to test if the warnings are scary enough :-)
image

image

image

Copy link
Member

@dain dain left a comment

Choose a reason for hiding this comment

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

Looks good to me

@nineinchnick
Copy link
Member Author

@mosabua great review, thanks! I added a lot more info as a separate commit. This just proves how complex this can get and how important it is to have extensive docs :-)

@nineinchnick nineinchnick requested a review from mosabua November 3, 2023 21:05
@nineinchnick
Copy link
Member Author

For k8s, I'll check later if it's easy to mount a persistent volume at /etc/trino/catalog when using the trino helm chart and if we need to document how to do that.

@mosabua
Copy link
Member

mosabua commented Nov 3, 2023

More comments .. very close. We should add some note that with dynamic mode catalogs are managed by the coordinator automatically so it also fully works for scaling clusters .. super cool! .. fyi @dain explained and confirmed this to me.

@nineinchnick
Copy link
Member Author

All comments applied. I tested this locally and all links look good. I've also run Vale this time and there are no issues.

@nineinchnick nineinchnick requested a review from mosabua November 4, 2023 08:51
@mosabua mosabua force-pushed the dynamic-catalogs-docs branch from cefb47f to 2a4c2b7 Compare November 6, 2023 21:23
Copy link
Member

@mosabua mosabua 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 now. Users will get excited to see these docs and start testing it out. Once the Hadoop libraries are removed as dependencies we can drop the warning about the object storage connectors.

@mosabua
Copy link
Member

mosabua commented Nov 6, 2023

I squashed commits and did some minor corrections btw.

@mosabua mosabua merged commit 1bc7b73 into trinodb:master Nov 6, 2023
@github-actions github-actions bot added this to the 433 milestone Nov 6, 2023
@nineinchnick nineinchnick deleted the dynamic-catalogs-docs branch November 6, 2023 22:01
- **Default value:** `false`

Requires [](prop-catalog-store) to be set to `file`. If true, existing catalog
property files cannot be removed with `DROP CATALOG`, and now new catalog files
Copy link
Member Author

Choose a reason for hiding this comment

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

There's a typo s/now/no

Copy link
Member

Choose a reason for hiding this comment

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

Dang.. can you fix that in your follow up PR maybe?

@hackeryang hackeryang mentioned this pull request Nov 9, 2023
21 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Development

Successfully merging this pull request may close these issues.

4 participants