8000 feat(dbapi): manual commit sample by IlyaFaer · Pull Request #187 · googleapis/python-spanner · GitHub
[go: up one dir, main page]

Skip to content

feat(dbapi): manual commit sample #187

8000
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 14 commits into from
Closed
64 changes: 64 additions & 0 deletions samples/samples/autocommit.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Copyright 2020 Google LLC
#
# Use of this source code is governed by a BSD-style
# license that can be found in the LICENSE file or at
# https://developers.google.com/open-source/licenses/bsd

import argparse

from google.cloud.spanner_dbapi import connect


def enable_autocommit_mode(instance_id, database_id):
"""Enables autocommit mode."""
# [START spanner_enable_autocommit_mode]

connection = connect(instance_id, database_id)
connection.autocommit = True
print("Autocommit mode is enabled.")

cursor = connection.cursor()

cursor.execute(
"""CREATE TABLE Singers (
SingerId INT64 NOT NULL,
FirstName STRING(1024),
LastName STRING(1024),
SingerInfo BYTES(MAX)
) PRIMARY KEY (SingerId)"""
)

cursor.execute(
"""INSERT INTO Singers (SingerId, FirstName, LastName) VALUES
(12, 'Melissa', 'Garcia'),
(13, 'Russell', 'Morales'),
(14, 'Jacqueline', 'Long'),
(15, 'Dylan', 'Shaw')"""
)

cursor.execute("""SELECT * FROM Singers WHERE SingerId = 13""")

print("SingerId: {}, AlbumId: {}, AlbumTitle: {}".format(*cursor.fetchone()))

connection.close()
# [END spanner_enable_autocommit_mode]


if __name__ == "__main__":
parser = argparse.ArgumentParser(
description=__doc__,
formatter_class=argparse.RawDescriptionHelpFormatter,
)
parser.add_argument("instance_id", help="Your Cloud Spanner instance ID.")
parser.add_argument(
"--database-id",
help="Your Cloud Spanner database ID.",
default="example_db",
)
subparsers = parser.add_subparsers(dest="command")
subparsers.add_parser("enable_autocommit_mode", help=enable_autocommit_mode.__doc__)
args = parser.parse_args()
if args.command == "enable_autocommit_mode":
enable_autocommit_mode(args.instance_id, args.database_id)
else:
print(f"Command {args.command} did not match expected commands.")
62 changes: 62 additions & 0 deletions samples/samples/autocommit_test.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# Copyright 2020 Google LLC
#
# Use of this source code is governed by a BSD-style
# license that can be found in the LICENSE file or at
# https://developers.google.com/open-source/licenses/bsd

import uuid

from google.cloud import spanner
from google.cloud.spanner_dbapi import connect
import mock
import pytest

import autocommit


def unique_instance_id():
"""Creates a unique id for the database."""
return f"test-instance-{uuid.uuid4().hex[:10]}"


def unique_database_id():
"""Creates a unique id for the database."""
return f"test-db-{uuid.uuid4().hex[:10]}"


INSTANCE_ID = unique_instance_id()
DATABASE_ID = unique_database_id()


@pytest.fixture(scope="module")
def spanner_instance():
spanner_client = spanner.Client()
config_name = f"{spanner_client.project_name}/instanceConfigs/regional-us-central1"

instance = spanner_client.instance(INSTANCE_ID, config_name)
op = instance.create()
op.result(120) # block until completion
yield instance
instance.delete()


@pytest.fixture(scope="module")
def database(spanner_instance):
"""Creates a temporary database that is removed after testing."""
db = spanner_instance.database(DATABASE_ID)
db.create()
yield db
db.drop()


def test_enable_autocommit_mode(capsys, database):
connection = connect(INSTANCE_ID, DATABASE_ID)
cursor = connection.cursor()

with mock.patch(
"google.cloud.spanner_dbapi.connection.Cursor", return_value=cursor,
):
autocommit.enable_autocommit_mode(INSTANCE_ID, DATABASE_ID)
out, _ = capsys.readouterr()
assert "Autocommit mode is enabled." in out
assert "SingerId: 13, AlbumId: Russell, AlbumTitle: Morales" in out
61 changes: 61 additions & 0 deletions samples/samples/manual_commit.py
< 8000 /tr>
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Copyright 2020 Google LLC
#
# Use of this source code is governed by a BSD-style
# license that can be found in the LICENSE file or at
# https://developers.google.com/open-source/licenses/bsd

import argparse

from google.cloud.spanner_dbapi import connect


def manual_commit(instance_id, database_id):
"""Use connection in !autocommit mode."""
# [START spanner_manual_commit]

connection = connect(instance_id, database_id)
cursor = connection.cursor()

cursor.execute(
"""CREATE TABLE Singers (
SingerId INT64 NOT NULL,
FirstName STRING(1024),
LastName STRING(1024),
SingerInfo BYTES(MAX)
) PRIMARY KEY (SingerId)"""
)
print("Transaction begun.")

cursor.execute(
"""INSERT INTO Singers (SingerId, FirstName, LastName) VALUES
(12, 'Melissa', 'Garcia'),
(13, 'Russell', 'Morales'),
(14, 'Jacqueline', 'Long'),
(15, 'Dylan', 'Shaw')"""
)

cursor.execute("""SELECT * FROM Singers WHERE SingerId = 13""")
connection.commit()
print("Transaction committed.")

print("SingerId: {}, AlbumId: {}, AlbumTitle: {}".format(*cursor.fetchone()))

connection.close()
# [END spanner_manual_commit]


if __name__ == "__main__":
parser = argparse.ArgumentParser(
description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter,
)
parser.add_argument("instance_id", help="Your Cloud Spanner instance ID.")
parser.add_argument(
"--database-id", help="Your Cloud Spanner database ID.", default="example_db",
)
subparsers = parser.add_subparsers(dest="command")
subparsers.add_parser("manual_commit", help=manual_commit.__doc__)
args = parser.parse_args()
if args.command == "manual_commit":
manual_commit(args.instance_id, args.database_id)
else:
print(f"Command {args.command} did not match expected commands.")
76 changes: 76 additions & 0 deletions samples/samples/transaction_management_test.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Copyright 2020 Google LLC
#
# Use of this source code is governed by a BSD-style
# license that can be found in the LICENSE file or at
# https://developers.google.com/open-source/licenses/bsd

import uuid

from google.cloud import spanner
from google.cloud.spanner_dbapi import connect
import mock
import pytest

import autocommit
import manual_commit


def unique_instance_id():
"""Creates a unique id for the database."""
return f"test-instance-{uuid.uuid4().hex[:10]}"


def unique_database_id():
"""Creates a unique id for the database."""
return f"test-db-{uuid.uuid4().hex[:10]}"


INSTANCE_ID = unique_instance_id()
DATABASE_ID = unique_database_id()


@pytest.fixture(scope="module")
def spanner_instance():
spanner_client = spanner.Client()
config_name = f"{spanner_client.project_name}/instanceConfigs/regional-us-central1"

instance = spanner_client.instance(INSTANCE_ID, config_name)
op = instance.create()
op.result(120) # block until completion
yield instance
instance.delete()


@pytest.fixture(scope="function")
def database(spanner_instance):
"""Creates a temporary database that is removed after testing."""
db = spanner_instance.database(DATABASE_ID)
db.create()
yield db
db.drop()


def test_enable_autocommit_mode(capsys, database):
connection = connect(INSTANCE_ID, DATABASE_ID)
cursor = connection.cursor()

with mock.patch(
"google.cloud.spanner_dbapi.connection.Cursor", return_value=cursor,
):
autocommit.enable_autocommit_mode(INSTANCE_ID, DATABASE_ID)
out, _ = capsys.readouterr()
assert "Autocommit mode is enabled." in out
assert "SingerId: 13, AlbumId: Russell, AlbumTitle: Morales" in out


def test_manual_commit(capsys, database):
connection = connect(INSTANCE_ID, DATABASE_ID)
cursor = connection.cursor()

with mock.patch(
"google.cloud.spanner_dbapi.connection.Cursor", return_value=cursor,
):
manual_commit.manual_commit(INSTANCE_ID, DATABASE_ID)
out, _ = capsys.readouterr()
assert "Transaction begun." in out
assert "SingerId: 13, AlbumId: Russell, AlbumTitle: Morales" in out
0