Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Document publish_changes procedure #8706

Merged
merged 2 commits into from
Oct 5, 2023
Merged

Conversation

nk1506
Copy link
Contributor

@nk1506 nk1506 commented Oct 3, 2023

added missing docs for procedures publish_changes.
As per today this is the only procedure missing from doc.

Fixes #1601

@github-actions github-actions bot added the docs label Oct 3, 2023
@nk1506 nk1506 changed the title Docs: Document all stored procedures. Docs: Document publish_changes procedure Oct 3, 2023
@@ -192,6 +192,44 @@ Cherry-pick snapshot 1 with named args
CALL catalog_name.system.cherrypick_snapshot(snapshot_id => 1, table => 'my_table' )
```

### `publish_changes`

Publish changes from a Staged WAP id into the current table state.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Publish changes from a Staged WAP id into the current table state.
Publish changes from a staged WAP ID into the current table state.


#### Usage

| Argument Name | Required? | Type | Description |
Copy link
Member

Choose a reason for hiding this comment

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

remove extra spaces and keep one trailing space.

For example, refer cherrypick_snapshot

Copy link
Member

Choose a reason for hiding this comment

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

same for all the new tables

| Argument Name | Required? | Type | Description |
|---------------|-----------|------|-------------------------------------------------|
| `table` | ✔️ | string | Name of the table to update |
| `wap_id` | ✔️ | long | The wap_id to be pusblished from stage to prod. |
Copy link
Member

Choose a reason for hiding this comment

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

nit: remove fullstop


#### Examples

publish_changes with wap_id 'wap_id_1'
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
publish_changes with wap_id 'wap_id_1'
publish_changes with WAP ID 'wap_id_1'

@nk1506
Copy link
Contributor Author

nk1506 commented Oct 5, 2023

@nastra , please look.

@nastra nastra merged commit a960d43 into apache:master Oct 5, 2023
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Spark SQL Extensions: Document all stored procedures
3 participants