---
title: Go client library for InfluxDB 3
description: The InfluxDB 3 influxdb3-go Go client library integrates with Go scripts and applications to write and query data stored in an InfluxDB Cloud Serverless bucket.
url: https://docs.influxdata.com/influxdb3/cloud-serverless/reference/client-libraries/v3/go/
estimated_tokens: 3810
product: InfluxDB Cloud Serverless
version: cloud-serverless
---

# Go client library for InfluxDB 3

The InfluxDB 3 [`influxdb3-go` Go client library](https://github.com/InfluxCommunity/influxdb3-go) integrates with Go scripts and applications to write and query data stored in an InfluxDB Cloud Serverless bucket.

## Installation

```sh
go get github.com/InfluxCommunity/influxdb3-go/v2
```

## Importing the package

The `influxdb3-go` client library module provides the `influxdb3` package.

Import the package:

```go
import (
    "github.com/InfluxCommunity/influxdb3-go/v2/influxdb3"
)
```

## API reference

### Function `New`

Create a client to interact with InfluxDB.

#### Syntax

```go
New(config ClientConfig)
```

Initializes and returns a `influxdb3.Client` instance with the following:

-   Configuration and functions for writing to the database.
-   A `*flight.Client` and functions for querying the database.

#### Parameters

-   **`config`**: A `ClientConfig` struct with the following configuration properties:
    
    -   **`Host`** (string): the InfluxDB Cloud Serverless server URL
    -   **`Token`** (string): a database token string
    -   **`Database`** (string): the database to use for writing and querying.
    -   **`Organization`** (string): *Optional*. The organization name or ID.
    -   **`HTTPClient`** (`*http.Client`): *Optional*. Specifies a custom HTTP client, TLS configuration, or timeout to use.
    -   **`WriteOptions`** (`*WriteOptions`): *Optional*. Options passed to the write client for writing to the bucket.
    -   **`Headers`** (`http.Header`): *Optional*. Headers to include in all requests.

#### Examples

##### Create an InfluxDB client

```go
package main

import (
    "github.com/InfluxCommunity/influxdb3-go/v2/influxdb3"
)

func Query() error {

    client, err := influxdb3.New(influxdb3.ClientConfig{
        Host:       "https://cloud2.influxdata.com",
        Token:      "API_TOKEN",
        Database:   "BUCKET_NAME",
    })

    defer func(client *influxdb3.Client) {
        err := client.Close()
        if err != nil {
            panic(err)
        }
    }(client)

    if(err != nil) {
        panic(err)
    }
}
```

Replace the following configuration values:

-   `BUCKET_NAME`: the name of the InfluxDB [bucket](/influxdb3/cloud-serverless/admin/buckets/) to query
-   `API_TOKEN`: an InfluxDB [API token](/influxdb3/cloud-serverless/admin/tokens/) with *read* permission on the specified bucket

## Class influxdb3.Client

### Function `Client.Query()`

Query data from InfluxDB 3 using SQL.

#### Syntax

```go
client.Query(ctx context.Context, query string)
```

Sends a Flight query request with SQL to InfluxDB.

Returns the following:

-   A custom iterator (\*QueryIterator) for accessing query result data and metadata.
-   An error, if any.

#### Parameters

-   **`ctx`** (`context.Context`): the context to use for the request
-   **`query`** (string): the SQL query to execute.

#### Examples

##### Query using SQL

```go
query := `SELECT *
  FROM home
  WHERE time >= '2022-01-02T08:00:00Z'
  AND time <= '2022-01-02T20:00:00Z'`

iterator, err := client.Query(context.Background(), query)
```

### Function `Client.QueryWithOptions()`

Query data from InfluxDB 3 with query options such as **query type** for querying with InfluxQL.

#### Syntax

```go
client.QueryWithOptions(ctx context.Context, options *QueryOptions, query string)
```

Sends a query request with the specified query options to InfluxDB.

Returns the following:

-   A custom iterator (\*QueryIterator) for accessing query result data and metadata.
-   An error, if any.

#### Parameters

-   **`ctx`** (`context.Context`): the context to use for the request
-   **`options`**: query options (query type, optional database)
-   **`query`** (string): the SQL or InfluxQL query to execute.

#### Examples

##### Query using InfluxQL

```go
query := `SELECT *
  FROM home
  WHERE time >= 1641124000s
  AND time <= 1641124000s + 8h`
queryOptions := influxdb3.QueryOptions{QueryType: influxdb3.InfluxQL}
iterator, err := client.QueryWithOptions(context.Background(), &queryOptions, query)
```