Starburst materialization documentation #1363
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
findinpath
reviewed
Feb 2, 2024
site/docs/reference/Connectors/materialization-connectors/starburst.md
Outdated
Show resolved
Hide resolved
site/docs/reference/Connectors/materialization-connectors/starburst.md
Outdated
Show resolved
Hide resolved
site/docs/reference/Connectors/materialization-connectors/starburst.md
Outdated
Show resolved
Hide resolved
site/docs/reference/Connectors/materialization-connectors/starburst.md
Outdated
Show resolved
Hide resolved
site/docs/reference/Connectors/materialization-connectors/starburst.md
Outdated
Show resolved
Hide resolved
|
|
||
| To get HOST and PORT go to your Cluster -> Connection info | ||
|
|
||
| There is also need to grant access to temporary storage (Roles and privileges -> Select specific role -> Privileges -> Add privilege -> Location). "Create schema and table in location" should be selected. |
There was a problem hiding this comment.
Add also the fact that the location privileges should correspond to the location of the schema configured for this connector.
site/docs/reference/Connectors/materialization-connectors/starburst.md
Outdated
Show resolved
Hide resolved
site/docs/reference/Connectors/materialization-connectors/starburst.md
Outdated
Show resolved
Hide resolved
| Galaxy has a list of reserved words that must be quoted in order to be used as an identifier. Flow automatically quotes fields that are in the reserved words list. You can find this list in Trino's documentation [here](https://trino.io/docs/current/language/reserved.html) and in the table below. | ||
|
|
||
| :::caution | ||
| In Galaxy, objects created with quoted identifiers must always be referenced exactly as created, including the quotes. Otherwise, SQL statements and queries can result in errors. See the [Trino docs](https://trino.io/docs/current/language/reserved.html#language-identifiers). |
There was a problem hiding this comment.
quoted identifiers -> is rather abstract for a newbie in the Trino ecosystem.
Maybe provide an example.
There was a problem hiding this comment.
Example is in Trino docs.
pajaks
force-pushed
the
starburst_doc
branch
2 times, most recently
from
ad52abc
to
ff0874b
Compare
findinpath
approved these changes
Feb 2, 2024
site/docs/reference/Connectors/materialization-connectors/starburst.md
Outdated
Show resolved
Hide resolved
findinpath
reviewed
Feb 2, 2024
site/docs/reference/Connectors/materialization-connectors/starburst.md
Outdated
Show resolved
Hide resolved
mattsfuller
reviewed
Feb 5, 2024
| * A Starburst Galaxy account (To create one: [Staburst Galaxy start](https://www.starburst.io/platform/starburst-galaxy/start/) that includes: | ||
| * A running cluster containing an [Amazon S3](https://docs.starburst.io/starburst-galaxy/working-with-data/create-catalogs/object-storage/s3.html) catalog | ||
| * A [schema](https://docs.starburst.io/starburst-galaxy/data-engineering/working-with-data-lakes/table-formats/index.html#create-schema) which is a logical grouping of tables | ||
| * Storage on S3 for temporary data with `awsAccessKeyId` and `awsSecretAccessKey` which should correspond to used catalog |
There was a problem hiding this comment.
Is there a reason why we didn't use cross account IAM role?
mattsfuller
reviewed
Feb 5, 2024
|
|
||
| To get host go to your Cluster -> Connection info -> Other clients ([Connect clients](https://docs.starburst.io/starburst-galaxy/working-with-data/query-data/connect-clients.html)) | ||
|
|
||
| There is also need to grant access to temporary storage (Roles and privileges -> Select specific role -> Privileges -> Add privilege -> Location). "Create schema and table in location" should be selected. [Doc](https://docs.starburst.io/starburst-galaxy/cluster-administration/manage-cluster-access/manage-users-roles-and-tags/account-and-cluster-privileges-and-entities.html#location-privileges-) |
mattsfuller
reviewed
Feb 5, 2024
| * A user with a role assigned that grants access to create, modify, drop tables in specified Amazon S3 catalog | ||
| * At least one Flow collection | ||
|
|
||
| ### Setup |
There was a problem hiding this comment.
Should specify this is setup for Starburst Galaxy
mattsfuller
reviewed
Feb 5, 2024
|
|
||
| There is also need to grant access to temporary storage (Roles and privileges -> Select specific role -> Privileges -> Add privilege -> Location). "Create schema and table in location" should be selected. [Doc](https://docs.starburst.io/starburst-galaxy/cluster-administration/manage-cluster-access/manage-users-roles-and-tags/account-and-cluster-privileges-and-entities.html#location-privileges-) | ||
|
|
||
| ## Configuration |
There was a problem hiding this comment.
Should call this setup for Estuary. Or call the other one configuration. Trying to be consistent in terminology for setups steps for both products.
mattsfuller
reviewed
Feb 5, 2024
| To use this connector, begin with data in one or more Flow collections. | ||
| Use the below properties to configure a Starburst materialization, which will direct one or more of your Flow collections to new Starburst tables. | ||
|
|
||
| ### Properties |
mattsfuller
reviewed
Feb 5, 2024
| | **`/awsAccessKeyId`** | AWS Access Key ID | | string | Required | | ||
| | **`/awsSecretAccessKey`** | AWS Secret Access Key | | string | Required | | ||
| | **`/region`** | AWS Region | Region of AWS storage | string | Required | | ||
| | **`/bucket`** | Bucket name | | string | Required | |
There was a problem hiding this comment.
Are these for the temporary storage?
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
|
LGTM |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
Add starburst documentation
This change is