activerecord-cockroachdb-adapter

(★ 105)

CockroachDB adapter for ActiveRecord.

File Explorer

Download Latest Version (.zip)

- - migrations.rb
  - models_and_database.rb
- - ci.yml
  - docker.yml
  - flaky.yml
- issue_template.md
- - default.rb
  - schemas.rb
- console
- minitest_bisect
- setup
- start-cockroachdb
- config.teamcity.yml
- Dockerfile
- local-test.sh
- teamcity-test.sh
- activerecord-cockroachdb-adapter.rb
- version.rb
- - adapter_test.rb
  - associations_test.rb
  - base_test.rb
  - comment_test.rb
  - defaults_test.rb
  - dirty_test.rb
  - fixtures_test.rb
  - helper_cockroachdb.rb
  - inheritance_test.rb
  - invertible_migration_test.rb
  - marshal_serialization_test.rb
  - migration_test.rb
  - persistence_test.rb
  - primary_keys_test.rb
  - relation_test.rb
  - relations_test.rb
  - schema_dumper_test.rb
  - show_create_test.rb
  - strict_loading_test.rb
  - test_fixtures_test.rb
  - transactions_test.rb
  - unsafe_raw_sql_test.rb
- - ActiveSupportSubclassWithFixturesTest.rb
  - BasicsTest.rb
  - BulkAlterTableMigrationsTest.rb
  - CalculationsTest.rb
  - CommentTest.rb
  - CoreTest.rb
  - CreateOrFindByWithinTransactions.rb
  - DefaultsUsingMultipleSchemasAndDomainTest.rb
  - DirtyTest.rb
  - EachTest.rb
  - EagerLoadPolyAssocsTest.rb
  - ExplicitlyNamedIndexMigrationTest.rb
  - FixturesResetPkSequenceTest.rb
  - FixturesTest.rb
  - FixturesWithForeignKeyViolationsTest.rb
  - ForeignTableTest.rb
  - InheritanceComputeTypeTest.rb
  - LeftOuterJoinAssociationTest.rb
  - MarshalSerializationTest.rb
  - MaterializedViewTest.rb
  - MigrationTest.rb
  - MultiDbMigratorTest.rb
  - NestedRelationScopingTest.rb
  - OrTest.rb
  - PersistenceTest.rb
  - PessimisticLockingTest.rb
  - PostgresqlArrayTest.rb
  - PostgresqlBigSerialTest.rb
  - PostgresqlBitStringTest.rb
  - PostgresqlByteaTest.rb
  - PostgresqlCitextTest.rb
  - PostgresqlCollationTest.rb
  - PostgresqlCompositeTest.rb
  - PostgresqlCompositeWithCustomOIDTest.rb
  - PostgresqlDataTypeTest.rb
  - PostgresqlDefaultExpressionTest.rb
  - PostgresqlDeferredConstraintsTest.rb
  - PostgresqlDomainTest.rb
  - PostgreSQLExplainTest.rb
  - PostgresqlExtensionMigrationTest.rb
  - PostgresqlFullTextTest.rb
  - PostgreSQLGeometricLineTest.rb
  - PostgresqlGeometricTest.rb
  - PostgreSQLGeometricTypesTest.rb
  - PostgresqlHstoreTest.rb
  - PostgresqlInfinityTest.rb
  - PostgresqlIntervalTest.rb
  - PostgresqlJSONBTest.rb
  - PostgresqlJSONTest.rb
  - PostgresqlLtreeTest.rb
  - PostgresqlMoneyTest.rb
  - PostgresqlNetworkTest.rb
  - PostgresqlNumberTest.rb
  - PostgreSQLPartitionsTest.rb
  - PostgresqlPointTest.rb
  - PostgresqlRangeTest.rb
  - PostgreSQLReferentialIntegrityTest.rb
  - PostgresqlRenameTableTest.rb
  - PostgresqlSerialTest.rb
  - PostgresqlTimestampFixtureTest.rb
  - PostgresqlTimestampMigrationTest.rb
  - PostgresqlTypeLookupTest.rb
  - PostgresqlUUIDGenerationTest.rb
  - PostgresqlUUIDTest.rb
  - PostgresqlVirtualColumnTest.rb
  - PostgresqlXMLTest.rb
  - PrimaryKeyIntegerNilDefaultTest.rb
  - PrimaryKeyIntegerTest.rb
  - PrimaryKeysTest.rb
  - QueryCacheExpiryTest.rb
  - RelationMergingTest.rb
  - RelationTest.rb
  - ReservedWordsMigrationTest.rb
  - SameNameDifferentDatabaseFixturesTest.rb
  - SanitizeTest.rb
  - SchemaAuthorizationTest.rb
  - SchemaCreateTableOptionsTest.rb
  - SchemaDumperDefaultsTest.rb
  - SchemaDumperTest.rb
  - SchemaForeignKeyTest.rb
  - SchemaIndexNullsOrderTest.rb
  - SchemaIndexOpclassTest.rb
  - SchemaTest.rb
  - StrictLoadingFixturesTest.rb
  - TestFixturesTest.rb
  - TransactionInstrumentationTest.rb
  - TransactionIsolationTest.rb
  - TypeTest.rb
  - UniquenessValidationTest.rb
  - UnloggedTablesTest.rb
  - UnsafeRawSqlTest.rb
  - UpdateableViewTest.rb
  - WithAnnotationsTest.rb
- - building.rb
  - spatial_model.rb
- - cockroachdb_specific_schema.rb
- - copy_cat.rb
  - exclude_from_transactional_tests.rb
  - paths_cockroachdb.rb
  - rake_helpers.rb
  - sql_logger.rb
  - template_creator.rb
- config.yml
.editorconfig
.gitignore
.gitmodules
activerecord-cockroachdb-adapter.gemspec
CHANGELOG.md
CONTRIBUTING.md
docker.sh
Gemfile
LICENSE
Rakefile
README.md
setup.sql

# Installation Guide

1. Get the code

git clone https://github.com/cockroachdb/activerecord-cockroachdb-adapter

Downloads the entire project code from GitHub to your computer.

cd activerecord-cockroachdb-adapter

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

Ruby Ruby is required to use gem.

gem install rgeo

Installs the package published on RubyGems directly.

gem install rgeo -- --with-geos-dir=/path/to/cockroach/lib/

Installs the package published on RubyGems directly.

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker build -f build/Dockerfile -t activerecord-cockroachdb-adapter .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 activerecord-cockroachdb-adapter

Runs the built image as an actual container.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. Ruby

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Ruby Ruby is required to use the bundle command.

bundle install

Installs the Ruby libraries listed in the Gemfile.

✅ If bundle install finishes without errors, continue with the run command from the README (e.g. rails server).