feat: Add Cockroachdb support without transactions #16394
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
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 |
|---|---|---|
|
|
@@ -36,5 +36,6 @@ jobs: | |
| snowflake | ||
| sqlite | ||
| types | ||
| cockroachdb | ||
| ignoreLabels: | | ||
| ignore-semantic-pull-request | ||
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
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,23 @@ | ||
| services: | ||
| cockroachdb-latest: | ||
| container_name: sequelize-cockroachdb-latest | ||
| image: cockroachdb/cockroach:v23.1.14 | ||
| ports: | ||
| - 26257:26257 | ||
| - 8080:8080 | ||
| command: start-single-node --cluster-name=cockroach-sequelize-example --advertise-addr='localhost' --insecure | ||
| environment: | ||
| COCKROACH_DATABASE: public | ||
| volumes: | ||
| - cockroach-single:/cockroach/cockroach-data | ||
| - ~/init-scripts:/docker-entrypoint-initdb.d | ||
| healthcheck: | ||
| test: curl --fail http://localhost:8080 || exit 1 | ||
| interval: 3s | ||
| timeout: 1s | ||
| retries: 10 | ||
| networks: | ||
| default: | ||
| name: sequelize-cockroachdb-latest-network | ||
| volumes: | ||
| cockroach-single: |
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,25 @@ | ||||||||||
| #!/usr/bin/env bash | ||||||||||
| set -Eeuxo pipefail # https://vaneyckt.io/posts/safer_bash_scripts_with_set_euxo_pipefail/ | ||||||||||
| cd -P -- "$(dirname -- "${BASH_SOURCE[0]}")" # https://stackoverflow.com/a/17744637 | ||||||||||
|
|
||||||||||
| docker compose -p sequelize-cockroachdb-latest down --remove-orphans | ||||||||||
| docker compose -p sequelize-cockroachdb-latest up -d | ||||||||||
|
|
||||||||||
| ./../../wait-until-healthy.sh sequelize-cockroachdb-latest | ||||||||||
|
|
||||||||||
| # Optimising the single node cluster | ||||||||||
| # Read more here https://cockroachlabs.com/docs/stable/local-testing.html#use-a-local-single-node-cluster-with-in-memory-storage | ||||||||||
| docker exec sequelize-cockroachdb-latest ./cockroach sql --insecure --execute=" | ||||||||||
| SET CLUSTER SETTING kv.raft_log.disable_synchronization_unsafe = true; | ||||||||||
| SET CLUSTER SETTING kv.range_merge.queue_interval = '50ms'; | ||||||||||
| SET CLUSTER SETTING jobs.registry.interval.gc = '30s'; | ||||||||||
| SET CLUSTER SETTING jobs.registry.interval.cancel = '180s'; | ||||||||||
| SET CLUSTER SETTING jobs.retention_time = '15s'; | ||||||||||
| SET CLUSTER SETTING sql.stats.automatic_collection.enabled = false; | ||||||||||
| SET CLUSTER SETTING kv.range_split.by_load_merge_delay = '5s'; | ||||||||||
| ALTER RANGE default CONFIGURE ZONE USING "gc.ttlseconds" = 600; | ||||||||||
| ALTER DATABASE system CONFIGURE ZONE USING "gc.ttlseconds" = 600; | ||||||||||
|
Comment on lines
+20
to
+21
There was a problem hiding this comment.
Suggested change
|
||||||||||
| DROP DATABASE IF EXISTS sequelize_test; | ||||||||||
| CREATE DATABASE IF NOT EXISTS sequelize_test; | ||||||||||
| CREATE USER IF NOT EXISTS sequelize_test; | ||||||||||
| GRANT admin TO sequelize_test;" | ||||||||||
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,7 @@ | ||
| #!/usr/bin/env bash | ||
| set -Eeuxo pipefail # https://vaneyckt.io/posts/safer_bash_scripts_with_set_euxo_pipefail/ | ||
| cd -P -- "$(dirname -- "${BASH_SOURCE[0]}")" # https://stackoverflow.com/a/17744637 | ||
|
|
||
| docker compose -p sequelize-cockroachdb-latest down --remove-orphans | ||
|
|
||
| echo "Cockroach db cluster stopped" |
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,23 @@ | ||
| services: | ||
| cockroachdb-oldest: | ||
| container_name: sequelize-cockroachdb-oldest | ||
| image: cockroachdb/cockroach:v22.2.0 | ||
| ports: | ||
| - 26257:26257 | ||
| - 8080:8080 | ||
| command: start-single-node --cluster-name=cockroach-sequelize-example --advertise-addr='localhost' --insecure | ||
| environment: | ||
| COCKROACH_DATABASE: public | ||
| volumes: | ||
| - cockroach-single:/cockroach/cockroach-data-oldest | ||
| - ~/init-scripts:/docker-entrypoint-initdb.d | ||
| healthcheck: | ||
| test: curl --fail http://localhost:8080 || exit 1 | ||
| interval: 3s | ||
| timeout: 1s | ||
| retries: 10 | ||
| networks: | ||
| default: | ||
| name: sequelize-cockroachdb-oldest-network | ||
| volumes: | ||
| cockroach-single: |
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,25 @@ | ||||||||||
| #!/usr/bin/env bash | ||||||||||
| set -Eeuxo pipefail # https://vaneyckt.io/posts/safer_bash_scripts_with_set_euxo_pipefail/ | ||||||||||
| cd -P -- "$(dirname -- "${BASH_SOURCE[0]}")" # https://stackoverflow.com/a/17744637 | ||||||||||
|
|
||||||||||
| docker compose -p sequelize-cockroachdb-oldest down --remove-orphans | ||||||||||
| docker compose -p sequelize-cockroachdb-oldest up -d | ||||||||||
|
|
||||||||||
| ./../../wait-until-healthy.sh sequelize-cockroachdb-oldest | ||||||||||
|
|
||||||||||
| # Optimising the single node cluster | ||||||||||
| # Read more here https://cockroachlabs.com/docs/stable/local-testing.html#use-a-local-single-node-cluster-with-in-memory-storage | ||||||||||
| docker exec sequelize-cockroachdb-oldest ./cockroach sql --insecure --execute=" | ||||||||||
| SET CLUSTER SETTING kv.raft_log.disable_synchronization_unsafe = true; | ||||||||||
| SET CLUSTER SETTING kv.range_merge.queue_interval = '50ms'; | ||||||||||
| SET CLUSTER SETTING jobs.registry.interval.gc = '30s'; | ||||||||||
| SET CLUSTER SETTING jobs.registry.interval.cancel = '180s'; | ||||||||||
| SET CLUSTER SETTING jobs.retention_time = '15s'; | ||||||||||
| SET CLUSTER SETTING sql.stats.automatic_collection.enabled = false; | ||||||||||
| SET CLUSTER SETTING kv.range_split.by_load_merge_delay = '5s'; | ||||||||||
| ALTER RANGE default CONFIGURE ZONE USING "gc.ttlseconds" = 600; | ||||||||||
| ALTER DATABASE system CONFIGURE ZONE USING "gc.ttlseconds" = 600; | ||||||||||
|
Comment on lines
+20
to
+21
There was a problem hiding this comment.
Suggested change
|
||||||||||
| DROP DATABASE IF EXISTS sequelize_test; | ||||||||||
| CREATE DATABASE IF NOT EXISTS sequelize_test; | ||||||||||
| CREATE USER IF NOT EXISTS sequelize_test; | ||||||||||
| GRANT admin TO sequelize_test;" | ||||||||||
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,7 @@ | ||
| #!/usr/bin/env bash | ||
| set -Eeuxo pipefail # https://vaneyckt.io/posts/safer_bash_scripts_with_set_euxo_pipefail/ | ||
| cd -P -- "$(dirname -- "${BASH_SOURCE[0]}")" # https://stackoverflow.com/a/17744637 | ||
|
|
||
| docker compose -p sequelize-cockroachdb-oldest down --remove-orphans | ||
|
|
||
| echo "Cockroach db cluster stopped" |
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
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
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
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,4 @@ | ||
| import { PostgresConnectionManager } from '../postgres/connection-manager'; | ||
|
|
||
| export class CockroachdbConnectionManager extends PostgresConnectionManager {} | ||
|
|
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,81 @@ | ||
| import assert from 'node:assert'; | ||
| import wkx from 'wkx'; | ||
| import * as BaseTypes from '../abstract/data-types'; | ||
| import { getDataTypeParser } from '../abstract/data-types-utils'; | ||
| import { buildRangeParser } from '../postgres/range'; | ||
| import type { CockroachDbDialect } from './index'; | ||
|
|
||
| export function registerCockroachDbDataTypeParsers(dialect: CockroachDbDialect) { | ||
| // dateonly | ||
| dialect.registerDataTypeParser(['date'], (value: unknown) => { | ||
| return value; | ||
| }); | ||
|
|
||
| dialect.registerDataTypeParser(['timestamptz', 'timestamp'], (value: unknown) => { | ||
| // override default parser to prevent returning a Date object (which is the default behavior in pg). | ||
| // return dates as string, not Date objects. Different implementations could be used instead (such as Temporal, dayjs) | ||
| return value; | ||
| }); | ||
|
|
||
| dialect.registerDataTypeParser(['decimal', 'numeric'], (value: string) => { | ||
| if (value === null) { | ||
| return null; | ||
| } | ||
|
|
||
| if (value === 'NaN') { | ||
| return Number.NaN; | ||
| } | ||
|
|
||
| return value; | ||
| }); | ||
|
|
||
| /** | ||
| * Cockroachdb's ALIAS for INTEGER and BIGINT defaults to int(64-bit value). So while retreiving the values from the database both values are | ||
| * returned as int8. While parsing them we cannot be sure if the expected behavior is of INTEGER or BIGINT so we make sure if the number is | ||
| * < than Number.MAX_SAFE_INTEGER --> Parse it as a number | ||
| * > than Number.MAX_SAFE_INTEGER --> Parse it as a string | ||
| * Note: Storing INTEGERS as INT4 and BIGINT as int8 would result in an anti-pattern since Cockroachdb uses unique_row_id() to generate a unique ID for | ||
| * each row by default to ensure global uniqueness, reseliency and consistency. | ||
| */ | ||
| dialect.registerDataTypeParser(['int8'], (value: string) => { | ||
| if (value === null) { | ||
| return null; | ||
| } | ||
|
|
||
| const parsedValue = BigInt(value); | ||
|
|
||
| if (parsedValue > Number.MAX_SAFE_INTEGER || parsedValue < Number.MIN_SAFE_INTEGER) { | ||
| return String(value); | ||
| } else if (Number(value) >= Number.MIN_SAFE_INTEGER) { | ||
| return Number(value); | ||
| } | ||
|
|
||
| return String(value); | ||
|
|
||
| }); | ||
|
|
||
| dialect.registerDataTypeParser(['geography'], (value: unknown) => { | ||
| assert(typeof value === 'string', 'Expected geography value to be a string'); | ||
|
|
||
| const b = Buffer.from(value, 'hex'); | ||
|
|
||
| return wkx.Geometry.parse(b).toGeoJSON({ shortCrs: true }); | ||
| }); | ||
|
|
||
| dialect.registerDataTypeParser(['geometry'], (value: unknown) => { | ||
| assert(typeof value === 'string', 'Expected geometry value to be a string'); | ||
|
|
||
| const b = Buffer.from(value, 'hex'); | ||
|
|
||
| return wkx.Geometry.parse(b).toGeoJSON({ shortCrs: true }); | ||
| }); | ||
|
|
||
| const parseInteger = getDataTypeParser(dialect, BaseTypes.INTEGER); | ||
| dialect.registerDataTypeParser(['int4range'], buildRangeParser(parseInteger)); | ||
|
|
||
| const parseBigInt = getDataTypeParser(dialect, BaseTypes.BIGINT); | ||
| dialect.registerDataTypeParser(['int8range'], buildRangeParser(parseBigInt)); | ||
|
|
||
| const parseDecimal = getDataTypeParser(dialect, BaseTypes.DECIMAL); | ||
| dialect.registerDataTypeParser(['numrange'], buildRangeParser(parseDecimal)); | ||
| } |
Oops, something went wrong.
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.
This should be added to the scopes in .github/workflows/pr-title.yml as well