From 691f687eb895737efe55c9f11b7cef8fc4e87d1e Mon Sep 17 00:00:00 2001 From: Dale Hui Date: Wed, 20 Dec 2023 00:28:14 -0800 Subject: [PATCH] Reformat ScyllaDB/Cassandra docs --- README.md | 5 ++--- database/cassandra/README.md | 12 ++++++++---- 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index ee6d19ee4..959601873 100644 --- a/README.md +++ b/README.md @@ -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)) diff --git a/database/cassandra/README.md b/database/cassandra/README.md index c138dff62..138104b7d 100644 --- a/database/cassandra/README.md +++ b/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