Skip to content

Commit

Permalink
Reformat ScyllaDB/Cassandra docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dhui committed Dec 20, 2023
1 parent eb64ffa commit 691f687
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 7 deletions.
5 changes: 2 additions & 3 deletions README.md
Expand Up @@ -28,12 +28,11 @@ Database drivers run migrations. [Add a new database?](database/driver.go)
* [PGX v5](database/pgx/v5)
* [Redshift](database/redshift)
* [Ql](database/ql)
* [Cassandra](database/cassandra)
* [ScyllaDB](database/cassandra)
* [Cassandra / ScyllaDB](database/cassandra)
* [SQLite](database/sqlite)
* [SQLite3](database/sqlite3) ([todo #165](https://github.com/mattes/migrate/issues/165))
* [SQLCipher](database/sqlcipher)
* [MySQL/ MariaDB](database/mysql)
* [MySQL / MariaDB](database/mysql)
* [Neo4j](database/neo4j)
* [MongoDB](database/mongodb)
* [CrateDB](database/crate) ([todo #170](https://github.com/mattes/migrate/issues/170))
Expand Down
12 changes: 8 additions & 4 deletions database/cassandra/README.md
@@ -1,12 +1,16 @@
# Cassandra / ScyllaDB

* Drop command will not work on Cassandra 2.X because it rely on
system_schema table which comes with 3.X. Works for ScyllaDB.
* Other commands should work properly but are **not tested**
* `Drop()` method will not work on Cassandra 2.X because it rely on
system_schema table which comes with 3.X
* Other methods should work properly but are **not tested**
* The Cassandra driver (gocql) does not natively support executing multiple statements in a single query. To allow for multiple statements in a single migration, you can use the `x-multi-statement` param. There are two important caveats:
* This mode splits the migration text into separately-executed statements by a semi-colon `;`. Thus `x-multi-statement` cannot be used when a statement in the migration contains a string with a semi-colon.
* The queries are not executed in any sort of transaction/batch, meaning you are responsible for fixing partial migrations.
* For ScyllaDB no additional configuration required as it is a drop-in replacement for Cassandra.

**ScyllaDB**

* No additional configuration is required since it is a drop-in replacement for Cassandra.
* The `Drop()` method` works for ScyllaDB 5.1


## Usage
Expand Down

0 comments on commit 691f687

Please sign in to comment.