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.

Sign up for GitHub

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

workflow updates for pgroll branches #373

Merged
merged 1 commit into from
Jul 29, 2024
Merged

workflow updates for pgroll branches #373

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions 020-Connect/010-Postgres/001-direct-access.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -285,6 +285,10 @@ Concurrent connections are limited by [plan](/docs/concepts/pricing#pricing-plan

Branch migrations are not supported yet. In databases that support direct Postgres access, you can create new branches but they cannot be merged together. This capability will become available later on.

### Workflow

Compatibility with the [PR based workflow](/docs/getting-started/workflow) is experimental as the migration system is being reworked based on [pgroll](https://github.com/xataio/pgroll).

## Column metadata

Xata uses SQL comments on columns to track some replication-related metadata about certain types of columns. These comments are only ever present on columns created using the Xata UI, and only on certain types of columns.
Expand Down
12 changes: 5 additions & 7 deletions 050-Manage/040-pr-based-workflow.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,11 @@ status: beta
## Migrations with GitHub

<Alert status="warning">
**This feature is in beta and is not yet compatible with databases that provide direct access to
[Postgres](/docs/postgres)**. We are currently rebuilding our migration strategy to incorporate
[pgroll](https://github.com/xataio/pgroll) alongside native Postgres support. Until then, migrations and branching as
documented below are limited in scope. The GitHub integration does not work within a monorepo with multiple Xata
databases. File attachments within records will not get copied to generated preview branches. There is no rebase
capability at present, which meants migrations should be linear and targeted towards the main branch. GitHub Pull
Requests that apply migrations cannot be reverted.
**This feature is in Beta with known limitations**. Migrations and branching as documented below are limited in scope.
The GitHub integration does not work within a monorepo with multiple Xata databases. File attachments within records
will not get copied to generated preview branches. No data will be copied to preview branches with Postgres-enabled
databases. There is no rebase capability at present, which meants migrations should be linear and targeted towards the
main branch. GitHub Pull Requests that apply migrations cannot be reverted.
</Alert>

This guide introduces the core Xata workflow and outlines the process of configuring a project for branching and migrations using GitHub in conjunction with Netlify or Vercel. After completing the configuration, pull requests created in GitHub will generate Xata database previews that link to preview deployments in either Vercel or Netlify. After merging the pull requests, Xata will perform database migrations in sync with your code, resulting in the deployment of changes to production.
Expand Down
Loading