Derek McQuay
59af8fc84f
Signed-off-by: Derek McQuay <derekmcquay@gmail.com> |
||
|---|---|---|
| .. | ||
| aetest | ||
| blobstore | ||
| capability | ||
| channel | ||
| cloudsql | ||
| cmd | ||
| datastore | ||
| delay | ||
| demos | ||
| file | ||
| image | ||
| internal | ||
| log | ||
| memcache | ||
| module | ||
| remote_api | ||
| runtime | ||
| search | ||
| socket | ||
| taskqueue | ||
| urlfetch | ||
| user | ||
| xmpp | ||
| .travis.yml | ||
| LICENSE | ||
| README.md | ||
| appengine.go | ||
| appengine_test.go | ||
| appengine_vm.go | ||
| errors.go | ||
| identity.go | ||
| namespace.go | ||
| namespace_test.go | ||
| timeout.go | ||
README.md
Go App Engine packages
This repository supports the Go runtime on App Engine,
including both the standard App Engine and the
"App Engine flexible environment" (formerly known as "Managed VMs").
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 Google App Engine issue tracker.
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 a Go App Engine app
This section describes how to update an older Go App Engine app to use
these packages. A provided tool, aefix, can help automate steps 2 and 3
(run go get google.golang.org/appengine/cmd/aefix to install it), but
read the details below since aefix can't perform all the changes.
1. Update YAML files (App Engine flexible environment / Managed VMs only)
The app.yaml file (and YAML files for modules) should have these new lines added:
vm: true
See https://cloud.google.com/appengine/docs/go/modules/#Go_Instance_scaling_and_class for details.
2. 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.
3. 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 some are not available yet. This list summarises the differences:
appengine.Contexthas been replaced with theContexttype fromgolang.org/x/net/context.- Logging methods that were on
appengine.Contextare now functions ingoogle.golang.org/appengine/log. appengine.Timeouthas been removed. Usecontext.WithTimeoutinstead.appengine.Datacenternow takes acontext.Contextargument.datastore.PropertyLoadSaverhas been simplified to use slices in place of channels.delay.Callnow returns an error.search.FieldLoadSavernow handles document metadata.urlfetch.Transportno longer has a Deadline field; set a deadline on thecontext.Contextinstead.aetestno longer declares its own Context type, and uses the standard one instead.taskqueue.QueueStatsno longer takes a maxTasks argument. That argument has been deprecated and unused for a long time.appengine.BackendHostnameandappengine.BackendInstancewere for the deprecated backends feature. Useappengine.ModuleHostnameandappengine.ModuleNameinstead.- Most of
appengine/fileand parts ofappengine/blobstoreare deprecated. Use Google Cloud Storage if the feature you require is not present in the new blobstore package. appengine/socketis not required on App Engine flexible environment / Managed VMs. Use the standardnetpackage instead.