eighty4 / cquill Goto Github PK

Developer workflows for adding new statements to a CQL file that's already been migrated to a local cassandra. There are two current approaches:

• Add new CQL files to migrate that will be merged into a single CQL file when development work is ready to be committed
• Repeatedly drop keyspace ... with cqlsh and rerun cquill migrate

Hibernate and Flyway supports dropping and recreating schemas for developer experience. This could be replicated with a --refresh or --dev-refresh flag on the migrate command.

I'm hesitant about introducing this as a param that could accidentally get ran against a production database. Another option would be to introduce a new command called dev that would behave like migrate with the extra step of removing the existing keyspaces.

The current CQL parsing before migrating a CQL file only separates statements, tracks line numbers and removes comments.

There are many enhancements that would benefit from generating an AST from a cql file before migrating. The primary benefit would be syntax validation before executing a query. This would reduce the chance of partially migrating a CQL file that would require manual cleanup.

Other potential enhancements include:

• formatter and linter features for developer experience
• suggest rollback CQL to rollback from an error after partially migrating a CQL file
• augmenting statements with an alternate keyspace for test isolation

There's an ANTLR crate that could be used with the cql3.0 grammar on antlr/grammars but it would probably be more fun to code a parser.

Is it possible to embed migrations and run them at startup? Is this feature outside the scope of this repository?