Skip to content

Commit e2800d6

Browse files
committed
improve doc.go documentation
1 parent 722707e commit e2800d6

File tree

7 files changed

+1340
-14
lines changed

7 files changed

+1340
-14
lines changed

README.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ Installation
3535

3636
go get github.com/apache/cassandra-gocql-driver/v2
3737

38+
**Note:** Version `2.0.0` introduces breaking changes. See the [upgrade guide](https://pkg.go.dev/github.com/apache/cassandra-gocql-driver/v2#hdr-Upgrade_guide_for_1_x_users) for upgrade instructions from `1.x`.
39+
3840

3941
Features
4042
--------
@@ -53,18 +55,29 @@ Features
5355
* Each connection can execute up to n concurrent queries (whereby n is the limit set by the protocol version the client chooses to use)
5456
* Optional automatic discovery of nodes
5557
* Policy based connection pool with token aware and round-robin policy implementations
58+
* Support for host-targeted queries with Query.SetHostID()
5659
* Support for password authentication
5760
* Iteration over paged results with configurable page size
5861
* 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)
6064
* Automatic query preparation
6165
* 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
6881
* An API to access the schema metadata of a given keyspace
6982

7083
Performance

0 commit comments

Comments
 (0)