This is a demo application for Cloud Spanner SQLAlchemy ORM.
A simple ranking API for gaming use cases.
- Language: Python 3
- Python package and virtualenv tool: Poetry
- Framework: FastAPI
- ORM: SQLAlchemy
- Migration tool: Alembic
- Server: Cloud Run
- DB: Cloud Spanner
- Container registry: Artifact Registry
- CI/CD: GitHub Actions
git clone https://github.com/kazshinohara/spanner-sqlalchemy-demo
cd spanner-sqlalchemy-demo
poetry installSet environment variables which are needed for the following steps.
export PROJECT_ID=""
export INSTANCE_ID=""
export DATABASE_ID=""
export SA_NAME=""
export SA_KEY_NAME=""Create a service account for this demo.
gcloud iam service-accounts create ${SA_NAME}Assign role to the service account.
gcloud projects add-iam-policy-binding ${PROJECT_ID} --member "serviceAccount:${SA_NAME}@${PROJECT_ID}.iam.gserviceaccount.com" --role "roles/spanner.databaseAdmin"Download the key file to your local machine.
gcloud iam service-accounts keys create ${SA_KEY_NAME} \
--iam-account=${SA_NAME}@${PROJECT_ID}.iam.gserviceaccount.comSet your key file location as an environment variable.
export GOOGLE_APPLICATION_CREDENTIALS=""Create Cloud Spanner instance and database.
gcloud spanner instances create ${INSTANCE_ID} --config=regional-asia-northeast1 --description="demo" --nodes=1
gcloud spanner databases create ${DATABASE_ID} --instance=${INSTANCE_ID}DB migration, Alembic uses your service account's credential to access Cloud Spanner.
cd spanner-sqlalchemy-demo/app
poetry run alembic revision --autogenerate -m "Initial migration"
poetry run alembic upgrade headNote: The following steps need environment variables which are set at Section 2.
cd spanner-sqlalchemy-demo
poetry run uvicorn app.main:app --reload
open http://127.0.0.1:8000/Note: The following steps need environment variables which are set at Section 2.
Run Cloud Spanner emulator.
docker run -p 9010:9010 -p 9020:9020 gcr.io/cloud-spanner-emulator/emulatorSet up Cloud Spanner emulator.
cd spanner-sqlalchemy-demo/tests
chmod u+x spanner_emulator_setup.sh
./spanner_emulator_setup.shSet environment variables which are needed for the following steps.
export SPANNER_EMULATOR_HOST=localhost:9010
export K_SERVICE=spanner-sqlalchemy-demo
export K_REVISION=spanner-sqlalchemy-demo-00001-thxRun the unit test.
cd spanner-sqlalchemy-demo/tests
poetry run pytestNote: The following steps need environment variables which are set at Section 2.
Set an environment variable which are needed for the following steps.
Please make sure that you have a docker image repo at Artifact Registry.
export REPOSITORY_NAME=""Build a container image.
cd spanner-sqlalchemy-demo
docker build -t asia-northeast1-docker.pkg.dev/${PROJECT_ID}/${REPOSITORY_NAME}/spanner-sqlalchemy-demo:1.0.0 .Push the image to Artifact Registry
cd spanner-sqlalchemy-demo
docker push asia-northeast1-docker.pkg.dev/${PROJECT_ID}/${REPOSITORY_NAME}/spanner-sqlalchemy-demo:1.0.0Deploy the container image to Cloud Run.
gcloud run deploy spanner-sqlalchemy-demo \
--image asia-northeast1-docker.pkg.dev/${PROJECT_ID}/${REPOSITORY_NAME}/spanner-sqlalchemy-demo:1.0.0 \
--allow-unauthenticated \
--set-env-vars=PROJECT_ID=${PROJECT_ID},INSTANCE_ID=${INSTANCE_ID},DATABASE_ID=${DATABASE_ID} \
--service-account=${SA_NAME}@${PROJECT_ID}.iam.gserviceaccount.com \
--region=asia-northeast1![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent