Go
This page documents the preview version (v2.23). Preview includes features under active development and is for development and testing only. For production, use the stable version (v2024.1). To learn more, see Versioning.
Supported projects
The following projects can be used to implement Golang applications using the YugabyteDB YSQL and YCQL APIs.
Project | Documentation and Guides | Latest Driver Version | Supported YugabyteDB Version |
---|---|---|---|
YugabyteDB PGX Driver [Recommended] | Documentation Reference |
v4 | 2.8 and above |
PGX Driver | Documentation Reference |
v4 | 2.8 and above |
PQ Driver | Documentation Reference |
v1.10.2 | 2.6 and above |
YugabyteDB Go Driver for YCQL | Documentation | 3.16.3 |
Project | Documentation and Guides | Example Apps |
---|---|---|
GORM [Recommended] | Documentation Hello World |
GORM App |
GO-PG | Documentation |
Learn how to establish a connection to a YugabyteDB database and begin basic CRUD operations by referring to Connect an app or Use an ORM.
Prerequisites
To develop Golang applications for YugabyteDB, you need the following:
-
Go
Install the latest Go (1.16 or later) on your system.
Run
go --version
in a terminal to check your version of Go. To install Go, visit Go Downloads. -
Create a Go project
For ease-of-use, use an integrated development environment (IDE) such as Visual Studio. To download and install Visual Studio, visit the Visual Studio Downloads page.
-
YugabyteDB cluster
- Create a free cluster on YugabyteDB Aeon. Refer to Use a cloud cluster. Note that YugabyteDB Aeon requires SSL.
- Alternatively, set up a standalone YugabyteDB cluster by following the steps in Install YugabyteDB.