diff --git a/cloud-sql/mysql/sqlalchemy/README.md b/cloud-sql/mysql/sqlalchemy/README.md new file mode 100644 index 000000000000..c4dfa654fed9 --- /dev/null +++ b/cloud-sql/mysql/sqlalchemy/README.md @@ -0,0 +1,70 @@ +# Connecting to Cloud SQL - MySQL + +## Before you begin + +1. If you haven't already, set up a Python Development Environment by following the [python setup guide](https://cloud.google.com/python/setup) and +[create a project](https://cloud.google.com/resource-manager/docs/creating-managing-projects#creating_a_project). + +1. Create a 2nd Gen Cloud SQL Instance by following these +[instructions](https://cloud.google.com/sql/docs/mysql/create-instance). Note the connection string, +database user, and database password that you create. + +1. Create a database for your application by following these +[instructions](https://cloud.google.com/sql/docs/mysql/create-manage-databases). Note the database +name. + +1. Create a service account with the 'Cloud SQL Client' permissions by following these +[instructions](https://cloud.google.com/sql/docs/mysql/connect-external-app#4_if_required_by_your_authentication_method_create_a_service_account). +Download a JSON key to use to authenticate your connection. + +1. Use the information noted in the previous steps: +```bash +export GOOGLE_APPLICATION_CREDENTIALS=/path/to/service/account/key.json +export CLOUD_SQL_CONNECTION_NAME='::' +export DB_USER='my-db-user' +export DB_PASS='my-db-pass' +export DB_NAME='my_db' +``` +Note: Saving credentials in environment variables is convenient, but not secure - consider a more +secure solution such as [Cloud KMS](https://cloud.google.com/kms/) to help keep secrets safe. + +## Running locally + +To run this application locally, download and install the `cloud_sql_proxy` by +following the instructions [here](https://cloud.google.com/sql/docs/mysql/sql-proxy#install). + +Once the proxy is ready, use the following command to start the proxy in the +background: +```bash +./cloud_sql_proxy -dir=/cloudsql --instances=$CLOUD_SQL_CONNECTION_NAME --credential_file=$GOOGLE_APPLICATION_CREDENTIALS +``` +Note: Make sure to run the command under a user with write access in the +`/cloudsql` directory. This proxy will use this folder to create a unix socket +the application will use to connect to Cloud SQL. + +Next, setup install the requirements into a virtual enviroment: +```bash +virtualenv --python python3 env +source env/bin/activate +pip install -r requirements.txt +``` + +Finally, start the application: +```bash +python main.py +``` + +Navigate towards `http://127.0.0.1:8080` to verify your application is running correctly. + +## Google App Engine Standard + +To run on GAE-Standard, create an App Engine project by following the setup for these +[instructions](https://cloud.google.com/appengine/docs/standard/python3/quickstart#before-you-begin). + +First, update `app.yaml` with the correct values to pass the environment +variables into the runtime. + +Next, the following command will deploy the application to your Google Cloud project: +```bash +gcloud app deploy +``` diff --git a/cloud-sql/mysql/sqlalchemy/app.yaml b/cloud-sql/mysql/sqlalchemy/app.yaml new file mode 100644 index 000000000000..b6959445df6b --- /dev/null +++ b/cloud-sql/mysql/sqlalchemy/app.yaml @@ -0,0 +1,23 @@ +# Copyright 2018 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +runtime: python37 + +# Remember - storing secrets in plaintext is potentially unsafe. Consider using +# something like https://cloud.google.com/kms/ to help keep secrets secret. +env_variables: + CLOUD_SQL_INSTANCE_NAME: :: + DB_USER: my-db-user + DB_PASS: my-db-pass + DB_NAME: my_db diff --git a/cloud-sql/mysql/sqlalchemy/main.py b/cloud-sql/mysql/sqlalchemy/main.py new file mode 100644 index 000000000000..da4457e281fa --- /dev/null +++ b/cloud-sql/mysql/sqlalchemy/main.py @@ -0,0 +1,174 @@ +# Copyright 2018 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import datetime +import logging +import os + +from flask import Flask, render_template, request, Response +import sqlalchemy + + +# Remember - storing secrets in plaintext is potentially unsafe. Consider using +# something like https://cloud.google.com/kms/ to help keep secrets secret. +db_user = os.environ.get("DB_USER") +db_pass = os.environ.get("DB_PASS") +db_name = os.environ.get("DB_NAME") +cloud_sql_instance_name = os.environ.get("CLOUD_SQL_INSTANCE_NAME") + +app = Flask(__name__) + +logger = logging.getLogger() + +# [START cloud_sql_mysql_connection_pool] +# The SQLAlchemy engine will help manage interactions, including automatically +# managing a pool of connections to your database +db = sqlalchemy.create_engine( + # Equivalent URL: + # mysql+pymysql://:@/?unix_socket=/cloudsql/ + sqlalchemy.engine.url.URL( + drivername='mysql+pymysql', + username=db_user, + password=db_pass, + database=db_name, + query={ + 'unix_socket': '/cloudsql/{}'.format(cloud_sql_instance_name) + } + ), + # ... Specify additional properties here. + # [START_EXCLUDE] + + # [START cloud_sql_mysql_limit_connections] + # Pool size is the maximum number of permanent connections to keep. + pool_size=5, + # Temporarily exceeds the set pool_size if no connections are available. + max_overflow=2, + # The total number of concurrent connections for your application will be + # a total of pool_size and max_overflow. + # [END cloud_sql_mysql_limit_connections] + + # [START cloud_sql_mysql_connection_backoff] + # SQLAlchemy automatically uses delays between failed connection attempts, + # but provides no arguments for configuration. + # [END cloud_sql_mysql_connection_backoff] + + # [START cloud_sql_mysql_connection_timeout] + # 'pool_timeout' is the maximum number of seconds to wait when retrieving a + # new connection from the pool. After the specified amount of time, an + # exception will be thrown. + pool_timeout=30, # 30 seconds + # [END cloud_sql_mysql_connection_timeout] + + # [START cloud_sql_mysql_connection_lifetime] + # 'pool_recycle' is the maximum number of seconds a connection can persist. + # Connections that live longer than the specified amount of time will be + # reestablished + pool_recycle=1800, # 30 minutes + # [END cloud_sql_mysql_connection_lifetime] + + # [END_EXCLUDE] +) +# [END cloud_sql_mysql_connection_pool] + + +@app.before_first_request +def create_tables(): + # Create tables (if they don't already exist) + with db.connect() as conn: + conn.execute( + "CREATE TABLE IF NOT EXISTS votes " + "( vote_id SERIAL NOT NULL, time_cast timestamp NOT NULL, " + "candidate CHAR(6) NOT NULL, PRIMARY KEY (vote_id) );" + ) + + +@app.route('/', methods=['GET']) +def index(): + votes = [] + with db.connect() as conn: + # Execute the query and fetch all results + recent_votes = conn.execute( + "SELECT candidate, time_cast FROM votes " + "ORDER BY time_cast DESC LIMIT 5" + ).fetchall() + # Convert the results into a list of dicts representing votes + for row in recent_votes: + votes.append({ + 'candidate': row[0], + 'time_cast': row[1] + }) + + stmt = sqlalchemy.text( + "SELECT COUNT(vote_id) FROM votes WHERE candidate=:candidate") + # Count number of votes for tabs + tab_result = conn.execute(stmt, candidate="TABS").fetchone() + tab_count = tab_result[0] + # Count number of votes for spaces + space_result = conn.execute(stmt, candidate="SPACES").fetchone() + space_count = space_result[0] + + return render_template( + 'index.html', + recent_votes=votes, + tab_count=tab_count, + space_count=space_count + ) + + +@app.route('/', methods=['POST']) +def save_vote(): + # Get the team and time the vote was cast. + team = request.form['team'] + time_cast = datetime.datetime.utcnow() + # Verify that the team is one of the allowed options + if team != "TABS" and team != "SPACES": + logger.warning(team) + return Response( + response="Invalid team specified.", + status=400 + ) + + # [START cloud_sql_mysql_example_statement] + # Preparing a statement before hand can help protect against injections. + stmt = sqlalchemy.text( + "INSERT INTO votes (time_cast, candidate)" + " VALUES (:time_cast, :candidate)" + ) + try: + # Using a with statement ensures that the connection is always released + # back into the pool at the end of statement (even if an error occurs) + with db.connect() as conn: + conn.execute(stmt, time_cast=time_cast, candidate=team) + except Exception as e: + # If something goes wrong, handle the error in this section. This might + # involve retrying or adjusting parameters depending on the situation. + # [START_EXCLUDE] + logger.exception(e) + return Response( + status=500, + response="Unable to successfully cast vote! Please check the " + "application logs for more details." + ) + # [END_EXCLUDE] + # [END cloud_sql_mysql_example_statement] + + return Response( + status=200, + response="Vote successfully cast for '{}' at time {}!".format( + team, time_cast) + ) + + +if __name__ == '__main__': + app.run(host='127.0.0.1', port=8080, debug=True) diff --git a/cloud-sql/mysql/sqlalchemy/requirements.txt b/cloud-sql/mysql/sqlalchemy/requirements.txt new file mode 100644 index 000000000000..4a60c2bf4672 --- /dev/null +++ b/cloud-sql/mysql/sqlalchemy/requirements.txt @@ -0,0 +1,3 @@ +Flask==1.0.2 +SQLAlchemy==1.2.13 +PyMySQL==0.9.2 diff --git a/cloud-sql/mysql/sqlalchemy/templates/index.html b/cloud-sql/mysql/sqlalchemy/templates/index.html new file mode 100644 index 000000000000..e390afaa5e2f --- /dev/null +++ b/cloud-sql/mysql/sqlalchemy/templates/index.html @@ -0,0 +1,100 @@ + + + + Tabs VS Spaces + + + + + + +
+
+

+ {% if tab_count == space_count %} + TABS and SPACES are evenly matched! + {% elif tab_count > space_count %} + TABS are winning by {{tab_count - space_count}} + {{'votes' if tab_count - space_count > 1 else 'vote'}}! + {% elif space_count > tab_count %} + SPACES are winning by {{space_count - tab_count}} + {{'votes' if space_count - tab_count > 1 else 'vote'}}! + {% endif %} +

+
+
+
+
+ keyboard_tab +

{{tab_count}} votes

+ +
+
+
+
+ space_bar +

{{space_count}} votes

+ +
+
+
+

Recent Votes

+
    + {% for vote in recent_votes %} +
  • + {% if vote.candidate == "TABS" %} + keyboard_tab + {% elif vote.candidate == "SPACES" %} + space_bar + {% endif %} + + A vote for {{vote.candidate}} + +

    was cast at {{vote.time_cast}}

    +
    • + {% endfor %} +
+
+ + +