-
Notifications
You must be signed in to change notification settings - Fork 7
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Drop-in replacement for gocql #296
Draft
Kulezi
wants to merge
17
commits into
main
Choose a base branch
from
pp/gocql
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Conversation
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
Kulezi
changed the title
gocql: drop-in replacement for gocql
Drop-in replacement for gocql
Sep 26, 2022
Kulezi
force-pushed
the
pp/gocql
branch
2 times, most recently
from
September 26, 2022 17:25
fd9f968
to
e006683
Compare
Kulezi
force-pushed
the
pp/gocql
branch
7 times, most recently
from
September 27, 2022 11:36
d838445
to
13c98c4
Compare
Kulezi
force-pushed
the
pp/gocql
branch
5 times, most recently
from
September 27, 2022 15:19
cef9091
to
6bca510
Compare
Kulezi
force-pushed
the
pp/gocql
branch
13 times, most recently
from
September 29, 2022 13:39
4870c2f
to
eb99068
Compare
can't wait to try it :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
GoCQL drop-in replacement
The goal of this pull request is to provide a gocql module inside the scylla-go-driver repository that could be used as a drop-in
replacement for gocql, just by using a replace directive in go.mod like this:
replace github.com/gocql/gocql => github.com/scylladb/scylla-go-driver/gocql <version/commit>
Benefits
Features: ORM, query building and migrations support can be used just by replacing GoCQL with the new driver in https://github.com/scylladb/gocqlx
Tests: Existing integration tests for GoCQLX, Scylla Manager, Scylla Operator, etc. can be used to test drivers correctness and safety.
Tests
New gocql package was tested against GocqlX and Scylla Manager tests.
GocqlX and Scylla Manager tests pass with exceptions:
I added a workflow to run the already passed tests on GitHub Actions, if you want to run them please refer to this action.
To pass the Scylla Manager tests its also needed to add two lines of code to the manager tests as gocql and the new driver return different error messages on unauthorised errors.
Changes
This PR makes many small changes mostly to the driver's API so it can provide a gocql compatible API in the gocql package,
those chages include:
gocql package
This PR features a new gocql package, wrapping Session, Query and Iter in structs exporting gocql API methods.
Base functionality is here, some missing gocql features are: