Go packages for Google Cloud Platform services

Clone this repo:
  1. 38a7def monitoring: declare beta by Jonathan Amsterdam · 11 hours ago master
  2. 08c975f language/apiv*: update client by Michael Darakananda · 25 hours ago
  3. c7cd507 profiler: auto detect service name and service version on App Engine by Jianqiao Li · 8 days ago
  4. 0b124d8 bigquery: fix panic in JobFromID by Jonathan Amsterdam · 4 days ago
  5. 58d5b92 bigquery: support jobs.list by Jonathan Amsterdam · 12 days ago

Google Cloud Client Libraries for Go

GoDoc

Go packages for Google Cloud Platform services.

import "cloud.google.com/go"

To install the packages on your system,

$ go get -u cloud.google.com/go/...

NOTE: Some of these packages are under development, and may occasionally make backwards-incompatible changes.

NOTE: Github repo is a mirror of https://code.googlesource.com/gocloud.

News

September 8, 2017

v0.13.0

  • bigquery: UseLegacySQL options for CreateTable and QueryConfig. Use these options to continue using Legacy SQL after the client switches its default to Standard SQL.

  • bigquery: Support for updating dataset labels.

  • bigquery: Set DatasetIterator.ProjectID to list datasets in a project other than the client's. DatasetsInProject is no longer needed and is deprecated.

  • bigtable: Fail ListInstances when any zones fail.

  • spanner: support decoding of slices of basic types (e.g. []string, []int64, etc.)

  • logging/logadmin: UpdateSink no longer creates a sink if it is missing (actually a change to the underlying service, not the client)

  • profiler: Service and ServiceVersion replace Target in Config.

August 22, 2017

v0.12.0

  • pubsub: Subscription.Receive now uses streaming pull.

  • pubsub: add Client.TopicInProject to access topics in a different project than the client.

  • errors: renamed errorreporting. The errors package will be removed shortly.

  • datastore: improved retry behavior.

  • bigquery: support updates to dataset metadata, with etags.

  • bigquery: add etag support to Table.Update (BREAKING: etag argument added).

  • bigquery: generate all job IDs on the client.

  • storage: support bucket lifecycle configurations.

July 31, 2017

v0.11.0

  • Clients for spanner, pubsub and video are now in beta.

  • New client for DLP.

  • spanner: performance and testing improvements.

  • storage: requester-pays buckets are supported.

  • storage, profiler, bigtable, bigquery: bug fixes and other minor improvements.

  • pubsub: bug fixes and other minor improvements

June 17, 2017

v0.10.0

  • pubsub: Subscription.ModifyPushConfig replaced with Subscription.Update.

  • pubsub: Subscription.Receive now runs concurrently for higher throughput.

  • vision: cloud.google.com/go/vision is deprecated. Use cloud.google.com/go/vision/apiv1 instead.

  • translation: now stable.

  • trace: several changes to the surface. See the link below.

Code changes required from v0.9.0.

Older news

Supported APIs

Google APIStatusPackage
Datastorestablecloud.google.com/go/datastore
Storagestablecloud.google.com/go/storage
Bigtablebetacloud.google.com/go/bigtable
BigQuerybetacloud.google.com/go/bigquery
Loggingstablecloud.google.com/go/logging
Monitoringbetacloud.google.com/go/monitoring/apiv3
Pub/Subbetacloud.google.com/go/pubsub
Visionstablecloud.google.com/go/vision/apiv1
Languagestablecloud.google.com/go/language/apiv1
Speechstablecloud.google.com/go/speech/apiv1
Spannerbetacloud.google.com/go/spanner
Translationstablecloud.google.com/go/translate
Tracealphacloud.google.com/go/trace
Video Intelligencebetacloud.google.com/go/videointelligence/apiv1beta1
ErrorReportingalphacloud.google.com/go/errorreporting

Alpha status: the API is still being actively developed. As a result, it might change in backward-incompatible ways and is not recommended for production use.

Beta status: the API is largely complete, but still has outstanding features and bugs to be addressed. There may be minor backwards-incompatible changes where necessary.

Stable status: the API is mature and ready for production use. We will continue addressing bugs and feature requests.

Documentation and examples are available at https://godoc.org/cloud.google.com/go

Visit or join the google-api-go-announce group for updates on these packages.

Go Versions Supported

We support the two most recent major versions of Go. If Google App Engine uses an older version, we support that as well. You can see which versions are currently supported by looking at the lines following go: in .travis.yml.

Authorization

By default, each API will use Google Application Default Credentials for authorization credentials used in calling the API endpoints. This will allow your application to run in many environments without requiring explicit configuration.

client, err := storage.NewClient(ctx)

To authorize using a JSON key file, pass option.WithServiceAccountFile to the NewClient function of the desired package. For example:

client, err := storage.NewClient(ctx, option.WithServiceAccountFile("path/to/keyfile.json"))

You can exert more control over authorization by using the golang.org/x/oauth2 package to create an oauth2.TokenSource. Then pass option.WithTokenSource to the NewClient function: snip:# (auth-ts)

tokenSource := ...
client, err := storage.NewClient(ctx, option.WithTokenSource(tokenSource))

Cloud Datastore GoDoc

Example Usage

First create a datastore.Client to use throughout your application:

client, err := datastore.NewClient(ctx, "my-project-id")
if err != nil {
	log.Fatal(err)
}

Then use that client to interact with the API:

type Post struct {
	Title       string
	Body        string `datastore:",noindex"`
	PublishedAt time.Time
}
keys := []*datastore.Key{
	datastore.NameKey("Post", "post1", nil),
	datastore.NameKey("Post", "post2", nil),
}
posts := []*Post{
	{Title: "Post 1", Body: "...", PublishedAt: time.Now()},
	{Title: "Post 2", Body: "...", PublishedAt: time.Now()},
}
if _, err := client.PutMulti(ctx, keys, posts); err != nil {
	log.Fatal(err)
}

Cloud Storage GoDoc

Example Usage

First create a storage.Client to use throughout your application:

client, err := storage.NewClient(ctx)
if err != nil {
	log.Fatal(err)
}
// Read the object1 from bucket.
rc, err := client.Bucket("bucket").Object("object1").NewReader(ctx)
if err != nil {
	log.Fatal(err)
}
defer rc.Close()
body, err := ioutil.ReadAll(rc)
if err != nil {
	log.Fatal(err)
}

Cloud Pub/Sub GoDoc

Example Usage

First create a pubsub.Client to use throughout your application:

client, err := pubsub.NewClient(ctx, "project-id")
if err != nil {
	log.Fatal(err)
}

Then use the client to publish and subscribe:

// Publish "hello world" on topic1.
topic := client.Topic("topic1")
res := topic.Publish(ctx, &pubsub.Message{
	Data: []byte("hello world"),
})
// The publish happens asynchronously.
// Later, you can get the result from res:
...
msgID, err := res.Get(ctx)
if err != nil {
	log.Fatal(err)
}

// Use a callback to receive messages via subscription1.
sub := client.Subscription("subscription1")
err = sub.Receive(ctx, func(ctx context.Context, m *pubsub.Message) {
	fmt.Println(m.Data)
	m.Ack() // Acknowledge that we've consumed the message.
})
if err != nil {
	log.Println(err)
}

Cloud BigQuery GoDoc

Example Usage

First create a bigquery.Client to use throughout your application: snip:# (bq-1)

c, err := bigquery.NewClient(ctx, "my-project-ID")
if err != nil {
	// TODO: Handle error.
}

Then use that client to interact with the API: snip:# (bq-2)

// Construct a query.
q := c.Query(`
    SELECT year, SUM(number)
    FROM [bigquery-public-data:usa_names.usa_1910_2013]
    WHERE name = "William"
    GROUP BY year
    ORDER BY year
`)
// Execute the query.
it, err := q.Read(ctx)
if err != nil {
	// TODO: Handle error.
}
// Iterate through the results.
for {
	var values []bigquery.Value
	err := it.Next(&values)
	if err == iterator.Done {
		break
	}
	if err != nil {
		// TODO: Handle error.
	}
	fmt.Println(values)
}

Stackdriver Logging GoDoc

Example Usage

First create a logging.Client to use throughout your application: snip:# (logging-1)

ctx := context.Background()
client, err := logging.NewClient(ctx, "my-project")
if err != nil {
	// TODO: Handle error.
}

Usually, you'll want to add log entries to a buffer to be periodically flushed (automatically and asynchronously) to the Stackdriver Logging service. snip:# (logging-2)

logger := client.Logger("my-log")
logger.Log(logging.Entry{Payload: "something happened!"})

Close your client before your program exits, to flush any buffered log entries. snip:# (logging-3)

err = client.Close()
if err != nil {
	// TODO: Handle error.
}

Cloud Spanner GoDoc

Example Usage

First create a spanner.Client to use throughout your application:

client, err := spanner.NewClient(ctx, "projects/P/instances/I/databases/D")
if err != nil {
	log.Fatal(err)
}
// Simple Reads And Writes
_, err = client.Apply(ctx, []*spanner.Mutation{
	spanner.Insert("Users",
		[]string{"name", "email"},
		[]interface{}{"alice", "a@example.com"})})
if err != nil {
	log.Fatal(err)
}
row, err := client.Single().ReadRow(ctx, "Users",
	spanner.Key{"alice"}, []string{"email"})
if err != nil {
	log.Fatal(err)
}

Contributing

Contributions are welcome. Please, see the CONTRIBUTING document for details. We‘re using Gerrit for our code reviews. Please don’t open pull requests against this repo, new pull requests will be automatically closed.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See Contributor Code of Conduct for more information.