-
Notifications
You must be signed in to change notification settings - Fork 4.1k
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
db migrations to support new webhook operations #17671
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
50 changes: 50 additions & 0 deletions
50
...a/io/airbyte/db/instance/configs/migrations/V0_40_12_001__AddWebhookOperationColumns.java
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
/* | ||
* Copyright (c) 2022 Airbyte, Inc., all rights reserved. | ||
*/ | ||
|
||
package io.airbyte.db.instance.configs.migrations; | ||
|
||
import org.flywaydb.core.api.migration.BaseJavaMigration; | ||
import org.flywaydb.core.api.migration.Context; | ||
import org.jooq.DSLContext; | ||
import org.jooq.impl.DSL; | ||
import org.jooq.impl.SQLDataType; | ||
import org.slf4j.Logger; | ||
import org.slf4j.LoggerFactory; | ||
|
||
// TODO: update migration description in the class name | ||
public class V0_40_12_001__AddWebhookOperationColumns extends BaseJavaMigration { | ||
|
||
private static final Logger LOGGER = LoggerFactory.getLogger(V0_40_12_001__AddWebhookOperationColumns.class); | ||
|
||
@Override | ||
public void migrate(final Context context) throws Exception { | ||
LOGGER.info("Running migration: {}", this.getClass().getSimpleName()); | ||
|
||
// Warning: please do not use any jOOQ generated code to write a migration. | ||
// As database schema changes, the generated jOOQ code can be deprecated. So | ||
// old migration may not compile if there is any generated code. | ||
final DSLContext ctx = DSL.using(context.getConnection()); | ||
addWebhookOperationConfigColumn(ctx); | ||
addWebhookOperationType(ctx); | ||
addWebhookConfigColumnsToWorkspaceTable(ctx); | ||
} | ||
|
||
private void addWebhookConfigColumnsToWorkspaceTable(final DSLContext ctx) { | ||
ctx.alterTable("workspace") | ||
.addColumnIfNotExists(DSL.field( | ||
"webhook_operation_configs", | ||
SQLDataType.JSONB.nullable(true))) | ||
.execute(); | ||
} | ||
|
||
private void addWebhookOperationType(final DSLContext ctx) { | ||
ctx.alterType("operator_type").addValue("webhook").execute(); | ||
} | ||
|
||
private void addWebhookOperationConfigColumn(final DSLContext ctx) { | ||
ctx.alterTable("operation").addColumnIfNotExists(DSL.field("operator_webhook", | ||
SQLDataType.JSONB.nullable(true))).execute(); | ||
} | ||
|
||
} |
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mfsiega-airbyte one bit I'm not sure I understand - can you remind me again why we need to add this to the
operation
table? Is it so we have a way to indicate that the operation is of a specific webhook type?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Basically: different connections might want different configs (and that happens by creating different entries in the
operation
table).There are a few reasons:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That sounds like something better suited for the
connection_operation
table. Maybe worth a quick sync tmrw?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
connection_operation
table today just holds:essentially just hooking up connections and operations. (I'm not 100% sure why the
connection_operation
table exists, instead of just having anoperation_ids
column on theconnection
table, but I assume there's a good reason).Whereas the
operation
table is where e.g., the existingdbt
transformation config lives (which is mostly how I decided to put it there).Regardless, +1 to syncing tomorrow - maybe good to run through the whole thing e2e for some early feedback as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
spoke offline: this is column is needed so webhook configs are stored on the operation table.