Go App Engine packages
Clone or download
Permalink
Failed to load latest commit information.
aetest aetest: new option to suppress dev_appserver logs (#119) Mar 29, 2018
blobstore blobstore: handle base64 encoding and non-UTF-8 charset (#129) Mar 28, 2018
capability Update more docs to follow new Managed VM branding. Mar 23, 2016
channel channel: add deprecation message (#78) Jun 30, 2017
cloudsql Update more docs to follow new Managed VM branding. Mar 23, 2016
cmd cmd/aedeploy: deprecate aedeploy (#65) Mar 21, 2017
datastore datastore: enable to set query batch size (#90) May 16, 2018
delay delay: permit Context from either stdlib or golang.org/x/net (#95) Oct 10, 2017
demos Update more docs to follow new Managed VM branding. Mar 23, 2016
file Remove internal.CallOptions entirely, and use the context's timeout f… Jan 28, 2015
image Remove internal.CallOptions entirely, and use the context's timeout f… Jan 28, 2015
internal internal: update identity to support GAE second generation runtimes (#… Sep 18, 2018
log log: clarify package docs (#83) Aug 1, 2017
mail mail, search: update doc URLs (#81) Jul 7, 2017
memcache Normalize namespace and transaction application. May 17, 2016
module Remove internal.CallOptions entirely, and use the context's timeout f… Jan 28, 2015
remote_api remote_api: don't modify http.Client parameter (#94) Oct 11, 2017
runtime runtime: update RunInBackground doc to include basic scaling. Aug 8, 2016
search search: fix language code of Japanese (#103) Mar 28, 2018
socket Update more docs to follow new Managed VM branding. Mar 23, 2016
taskqueue delay: make it possible to get taskqueue HTTP headers from inside a d… Aug 14, 2017
urlfetch Use the context's deadline for urlfetch, and drop urlfetch.Transport'… May 27, 2015
user user: check for valid context and panic if not (#70) Apr 10, 2017
xmpp Remove internal.CallOptions entirely, and use the context's timeout f… Jan 28, 2015
.travis.yml travis.yml: test with 1.9, most recent minor vs (#100) Oct 31, 2017
CONTRIBUTING.md CONTRIBUTING.md: adds file (#42) Jan 6, 2017
LICENSE Add LICENSE file. Feb 7, 2014
README.md README: update for flex (#61) Mar 21, 2017
appengine.go internal: for Flex, use req.Context instead of a context map (#107) Dec 12, 2017
appengine_test.go Add missing copyright headers. Aug 25, 2015
appengine_vm.go appengine: introduce appengine.Main() for Standard. Jul 7, 2016
errors.go Remove appengine.IsCapabilityDisabled. Feb 6, 2014
go.mod modules: Update github.com/golang/protobuf to v1.2.0 (#160) Sep 18, 2018
go.sum modules: Update github.com/golang/protobuf to v1.2.0 (#160) Sep 18, 2018
identity.go appengine: name returned parameters on SignBytes to improve documenta… Apr 7, 2015
namespace.go Refactor namespace application so it gets correctly applied implicitly. Jan 4, 2016
namespace_test.go Normalize namespace and transaction application. May 17, 2016
timeout.go Remove internal.CallOptions entirely, and use the context's timeout f… Jan 28, 2015

README.md

Go App Engine packages

Build Status

This repository supports the Go runtime on App Engine standard. It provides APIs for interacting with App Engine services. Its canonical import path is google.golang.org/appengine.

See https://cloud.google.com/appengine/docs/go/ for more information.

File issue reports and feature requests on the GitHub's issue tracker.

Upgrading an App Engine app to the flexible environment

This package does not work on App Engine flexible.

There are many differences between the App Engine standard environment and the flexible environment.

See the documentation on upgrading to the flexible environment.

Directory structure

The top level directory of this repository is the appengine package. It contains the basic APIs (e.g. appengine.NewContext) that apply across APIs. Specific API packages are in subdirectories (e.g. datastore).

There is an internal subdirectory that contains service protocol buffers, plus packages required for connectivity to make API calls. App Engine apps should not directly import any package under internal.

Updating from legacy (import "appengine") packages

If you're currently using the bare appengine packages (that is, not these ones, imported via google.golang.org/appengine), then you can use the aefix tool to help automate an upgrade to these packages.

Run go get google.golang.org/appengine/cmd/aefix to install it.

1. Update import paths

The import paths for App Engine packages are now fully qualified, based at google.golang.org/appengine. You will need to update your code to use import paths starting with that; for instance, code importing appengine/datastore will now need to import google.golang.org/appengine/datastore.

2. Update code using deprecated, removed or modified APIs

Most App Engine services are available with exactly the same API. A few APIs were cleaned up, and there are some differences:

  • appengine.Context has been replaced with the Context type from golang.org/x/net/context.
  • Logging methods that were on appengine.Context are now functions in google.golang.org/appengine/log.
  • appengine.Timeout has been removed. Use context.WithTimeout instead.
  • appengine.Datacenter now takes a context.Context argument.
  • datastore.PropertyLoadSaver has been simplified to use slices in place of channels.
  • delay.Call now returns an error.
  • search.FieldLoadSaver now handles document metadata.
  • urlfetch.Transport no longer has a Deadline field; set a deadline on the context.Context instead.
  • aetest no longer declares its own Context type, and uses the standard one instead.
  • taskqueue.QueueStats no longer takes a maxTasks argument. That argument has been deprecated and unused for a long time.
  • appengine.BackendHostname and appengine.BackendInstance were for the deprecated backends feature. Use appengine.ModuleHostnameand appengine.ModuleName instead.
  • Most of appengine/file and parts of appengine/blobstore are deprecated. Use Google Cloud Storage if the feature you require is not present in the new blobstore package.
  • appengine/socket is not required on App Engine flexible environment / Managed VMs. Use the standard net package instead.