You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update documentation for 2.0 (readme, upgrade guide, pkg.go.dev)
This patch updates the existing pkg.go.dev documentation and adds documentation for the new packages.
This patch also updates the README ands adds a new UPGRADE_GUIDE.md with some documentation for users that will be upgrading from 1.x to 2.x.
Patch by João Reis; reviewed by TBD for CASSGO-79
Copy file name to clipboardExpand all lines: README.md
+20-7Lines changed: 20 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,6 +35,8 @@ Installation
35
35
36
36
go get github.com/apache/cassandra-gocql-driver/v2
37
37
38
+
**Note:** Version `2.0.0` introduces breaking changes. See the [upgrade guide](https://github.com/apache/cassandra-gocql-driver/blob/trunk/UPGRADE_GUIDE.md) for upgrade instructions from `1.x`.
39
+
38
40
39
41
Features
40
42
--------
@@ -53,18 +55,29 @@ Features
53
55
* Each connection can execute up to n concurrent queries (whereby n is the limit set by the protocol version the client chooses to use)
54
56
* Optional automatic discovery of nodes
55
57
* Policy based connection pool with token aware and round-robin policy implementations
58
+
* Support for host-targeted queries with Query.SetHostID()
56
59
* Support for password authentication
57
60
* Iteration over paged results with configurable page size
58
61
* Support for TLS/SSL
59
-
* Optional frame compression (using snappy)
62
+
* Optional frame compression (Snappy and LZ4 available in separate packages)
63
+
* Structured logging support with dedicated packages for popular loggers (Zap, Zerolog)
60
64
* Automatic query preparation
61
65
* Support for query tracing
62
-
* Support for Cassandra 2.1+ [binary protocol version 3](https://github.com/apache/cassandra/blob/trunk/doc/native_protocol_v3.spec)
63
-
* Support for up to 32768 streams
64
-
* Support for tuple types
65
-
* Support for client side timestamps by default
66
-
* Support for UDTs via a custom marshaller or struct tags
67
-
* Support for Cassandra 3.0+ [binary protocol version 4](https://github.com/apache/cassandra/blob/trunk/doc/native_protocol_v4.spec)
66
+
* Support for Cassandra 2.1+ through 5.0+ with native protocol versions 3, 4, and 5:
67
+
***Protocol 3** (Cassandra 2.1+):
68
+
* Support for up to 32768 streams
69
+
* Support for tuple types
70
+
* Support for client side timestamps by default
71
+
* Support for UDTs via a custom marshaller or struct tags
72
+
***Protocol 4** (Cassandra 3.0+):
73
+
* All Protocol 3 features
74
+
* Enhanced performance and efficiency
75
+
***Protocol 5** (Cassandra 4.0+):
76
+
* All previous protocol features
77
+
* Support for per-query keyspace override (Query.SetKeyspace(), Batch.SetKeyspace())
78
+
* Support for per-query custom timestamps (Query.WithNowInSeconds(), Batch.WithNowInSeconds())
79
+
***Cassandra 5.0+ specific**:
80
+
* Support for vector types for vector search capabilities
68
81
* An API to access the schema metadata of a given keyspace
0 commit comments