feat: add samples

samples/autocommit.py

@@ -9,7 +9,7 @@
 
 def enable_autocommit_mode(url):
     """Enables autocommit mode."""
-    # [START sqlalchemy_spanner_autocmmit_on]
+    # [START sqlalchemy_spanner_autocommit_on]
 
     conn = create_engine(url).connect()
     level = conn.get_isolation_level()
@@ -21,5 +21,5 @@ def enable_autocommit_mode(url):
     print("Connection autocommit mode is {}".format(level))
     print("Spanner DBAPI autocommit mode is {}".format(conn.connection.connection.autocommit))
 
-    # [END sqlalchemy_spanner_autocmmit_on]
+    # [END sqlalchemy_spanner_autocommit_on]
     return conn

samples/get_table_names.py

@@ -12,7 +12,7 @@ def get_table_names(url):
 
     # TODO(developer): Create the table
     # table = Table(
-    #    table_id,
+    #    table_name,
     #    metadata,
     #    Column("user_id", Integer, primary_key=True),
     #    Column("user_name", String(16), nullable=False),

samples/table_create_unique_index.py

@@ -0,0 +1,26 @@
+# Copyright 2021 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
+
+from sqlalchemy import Index
+
+
+def create_unique_indexes(table_id):
+    """Create unique index"""
+
+    # TODO(developer): Create the table
+    # table = Table(
+    #    table_name,
+    #    metadata,
+    #    Column("user_id", Integer, primary_key=True),
+    #    Column("user_name", String(16), nullable=False),
+    # )
+    # table.create()
+
+    # [START sqlalchemy_spanner_create_unique_indexes]
+    index = Index("some_index", table_id.c.user_name, unique=True)
+    index.create()
+    print("Index created successfully")
+    # [END sqlalchemy_spanner_create_unique_indexes]

samples/table_delete_all_rows.py

@@ -10,7 +10,7 @@ def delete_all_rows(table):
 
     # TODO(developer): Create the table
     # table = Table(
-    #    table_id,
+    #    table_name,
     #    metadata,
     #    Column("user_id", Integer, primary_key=True),
     #    Column("user_name", String(16), nullable=False),

samples/table_delete_row_with_where_condition.py

@@ -10,7 +10,7 @@ def delete_row_with_where_condition(table):
 
     # TODO(developer): Create the table
     # table = Table(
-    #    table_id,
+    #    table_name,
     #    metadata,
     #    Column("user_id", Integer, primary_key=True),
     #    Column("user_name", String(16), nullable=False),

samples/table_exists.py

@@ -11,7 +11,7 @@ def table_exists(table):
 
     # TODO(developer): Create the table
     # table = Table(
-    #    table_id,
+    #    table_name,
     #    metadata,
     #    Column("user_id", Integer, primary_key=True),
     #    Column("user_name", String(16), nullable=False),

samples/table_fetch_row_with_where_condition.py

@@ -10,7 +10,7 @@ def fetch_row_with_where_condition(table):
 
     # TODO(developer): Create the table
     # table = Table(
-    #    table_id,
+    #    table_name,
     #    metadata,
     #    Column("user_id", Integer, primary_key=True),
     #    Column("user_name", String(16), nullable=False),

samples/table_fetch_rows.py

@@ -6,11 +6,11 @@
 
 
 def fetch_rows(table):
-    """fetch all rows from the table"""
+    """Fetch all rows from the table"""
 
     # TODO(developer): Create the table
     # table = Table(
-    #    table_id,
+    #    table_name,
     #    metadata,
     #    Column("user_id", Integer, primary_key=True),
     #    Column("user_name", String(16), nullable=False),

samples/table_fetch_rows_with_limit.py

@@ -0,0 +1,31 @@
+# Copyright 2021 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
+
+
+def fetch_rows_with_limit(table):
+    """Fetch rows from the table with limit"""
+
+    # TODO(developer): Create the table
+    # table = Table(
+    #    table_name,
+    #    metadata,
+    #    Column("user_id", Integer, primary_key=True),
+    #    Column("user_name", String(16), nullable=False),
+    # )
+    # table.create()
+
+    table.insert().execute([
+        {"user_id": 1, "user_name": 'GEH'},
+        {"user_id": 2, "user_name": 'DEF'},
+        {"user_id": 3, "user_name": 'HIJ'},
+        {"user_id": 4, "user_name": 'ABC'}
+    ])
+
+    # [START sqlalchemy_spanner_fetch_rows_with_limit]
+    result = list(table.select().limit(2).execute())
+    print("The rows are:", result)
+    # [END sqlalchemy_spanner_fetch_rows_with_limit]
+    return result

samples/table_fetch_rows_with_limit_offset.py

@@ -0,0 +1,31 @@
+# Copyright 2021 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
+
+
+def fetch_rows_with_offset(table):
+    """Fetch rows from the table with limit and offset"""
+
+    # TODO(developer): Create the table
+    # table = Table(
+    #    table_name,
+    #    metadata,
+    #    Column("user_id", Integer, primary_key=True),
+    #    Column("user_name", String(16), nullable=False),
+    # )
+    # table.create()
+
+    table.insert().execute([
+        {"user_id": 1, "user_name": 'GEH'},
+        {"user_id": 2, "user_name": 'DEF'},
+        {"user_id": 3, "user_name": 'HIJ'},
+        {"user_id": 4, "user_name": 'ABC'}
+    ])
+
+    # [START sqlalchemy_spanner_fetch_rows_with_limit_offset]
+    result = list(table.select().limit(2).offset(1).execute())
+    print("The rows are:", result)
+    # [END sqlalchemy_spanner_fetch_rows_with_limit_offset]
+    return result

samples/table_fetch_rows_with_offset.py

@@ -0,0 +1,31 @@
+# Copyright 2021 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
+
+
+def fetch_rows_with_offset(table):
+    """Fetch rows from the table with offset"""
+
+    # TODO(developer): Create the table
+    # table = Table(
+    #    table_name,
+    #    metadata,
+    #    Column("user_id", Integer, primary_key=True),
+    #    Column("user_name", String(16), nullable=False),
+    # )
+    # table.create()
+
+    table.insert().execute([
+        {"user_id": 1, "user_name": 'GEH'},
+        {"user_id": 2, "user_name": 'DEF'},
+        {"user_id": 3, "user_name": 'HIJ'},
+        {"user_id": 4, "user_name": 'ABC'}
+    ])
+
+    # [START sqlalchemy_spanner_fetch_rows_with_offset]
+    result = list(table.select().offset(1).execute())
+    print("The rows are:", result)
+    # [END sqlalchemy_spanner_fetch_rows_with_offset]
+    return result

samples/table_fetch_rows_with_order_by.py

@@ -6,11 +6,11 @@
 
 
 def fetch_rows_with_order_by(table):
-    """fetch all rows from the table in order"""
+    """Fetch all rows from the table in order"""
 
     # TODO(developer): Create the table
     # table = Table(
-    #    table_id,
+    #    table_name,
     #    metadata,
     #    Column("user_id", Integer, primary_key=True),
     #    Column("user_name", String(16), nullable=False),

samples/table_filter_data_endswith.py

@@ -6,11 +6,11 @@
 
 
 def filter_data_endswith(table):
-    """filter data with endswith from the table"""
+    """Filter data with endswith from the table"""
 
     # TODO(developer): Create the table
     # table = Table(
-    #    table_id,
+    #    table_name,
     #    metadata,
     #    Column("user_id", Integer, primary_key=True),
     #    Column("user_name", String(16), nullable=False),

samples/table_filter_data_startswith.py

@@ -6,11 +6,11 @@
 
 
 def filter_data_startswith(table):
-    """filter data with startswith from the table"""
+    """Filter data with startswith from the table"""
 
     # TODO(developer): Create the table
     # table = Table(
-    #    table_id,
+    #    table_name,
     #    metadata,
     #    Column("user_id", Integer, primary_key=True),
     #    Column("user_name", String(16), nullable=False),

samples/table_filter_data_with_contains.py

@@ -6,11 +6,11 @@
 
 
 def filter_data_with_contains(table):
-    """filter data with contains from the table"""
+    """Filter data with contains from the table"""
 
     # TODO(developer): Create the table
     # table = Table(
-    #    table_id,
+    #    table_name,
     #    metadata,
     #    Column("user_id", Integer, primary_key=True),
     #    Column("user_name", String(16), nullable=False),

samples/table_filter_data_with_like.py

@@ -6,11 +6,11 @@
 
 
 def filter_data_with_like(table):
-    """filter data with like from the table"""
+    """Filter data with like from the table"""
 
     # TODO(developer): Create the table
     # table = Table(
-    #    table_id,
+    #    table_name,
     #    metadata,
     #    Column("user_id", Integer, primary_key=True),
     #    Column("user_name", String(16), nullable=False),

samples/table_get_columns.py

@@ -12,7 +12,7 @@ def get_table_columns(url, table_id):
 
     # TODO(developer): Create the table
     # table = Table(
-    #    table_id,
+    #    table_name,
     #    metadata,
     #    Column("user_id", Integer, primary_key=True),
     #    Column("user_name", String(16), nullable=False),

samples/table_get_foreign_key.py

@@ -0,0 +1,43 @@
+# Copyright 2021 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
+
+from sqlalchemy import create_engine, inspect
+
+
+def get_table_foreign_key(url, table_id):
+    """Retrieve the Foreign key of the table"""
+
+    # TODO(developer): Create the table
+    # table1 = Table(
+    #    table1_name,
+    #    metadata,
+    #    Column("user_id", Integer, primary_key=True),
+    #    Column("user_name", String(16), nullable=False),
+    # )
+    # table1.create()
+
+    # TODO(developer): Create the table with foreign key
+    # table2 = Table(
+    #     table2_name,
+    #     metadata,
+    #     Column("id", Integer, primary_key=True),
+    #     Column("name", String(16), nullable=False),
+    #     Column(
+    #         "table1_id",
+    #         Integer,
+    #         ForeignKey("table1.id", name="table1id")
+    #     ),
+    # )
+    # table2.create()
+
+    # [START sqlalchemy_spanner_get_foreign_key]
+    engine = create_engine(url)
+    insp = inspect(engine)
+    f_key = insp.get_foreign_keys(table_id.name)
+
+    print("Foreign key is:", f_key)
+    # [END sqlalchemy_spanner_get_foreign_key]
+    return f_key

samples/table_get_indexes.py

@@ -0,0 +1,33 @@
+# Copyright 2021 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
+
+from sqlalchemy import create_engine, inspect, Index
+
+
+def get_table_indexes(url, table_id):
+    """Retrieve the Indexes of the table"""
+
+    # TODO(developer): Create the table
+    # table = Table(
+    #    table_name,
+    #    metadata,
+    #    Column("user_id", Integer, primary_key=True),
+    #    Column("user_name", String(16), nullable=False),
+    # )
+    # table.create()
+
+    # Create Index
+    index = Index("some_index", table_id.c.user_name)
+    index.create()
+
+    # [START sqlalchemy_spanner_get_indexes]
+    engine = create_engine(url)
+    insp = inspect(engine)
+    indexes = insp.get_indexes(table_id.name)
+
+    print("Indexes are:", indexes)
+    # [END sqlalchemy_spanner_get_indexes]
+    return indexes

samples/table_get_primary_key.py

@@ -8,11 +8,11 @@
 
 
 def get_table_primary_key(url, table_id):
-    """Retrieve the primary key of the table"""
+    """Retrieve the Primary key of the table"""
 
     # TODO(developer): Create the table
     # table = Table(
-    #    table_id,
+    #    table_name,
     #    metadata,
     #    Column("user_id", Integer, primary_key=True),
     #    Column("user_name", String(16), nullable=False),

samples/table_insert_row.py

@@ -10,7 +10,7 @@ def insert_row(table):
 
     # TODO(developer): Create the table
     # table = Table(
-    #    table_id,
+    #    table_name,
     #    metadata,
     #    Column("user_id", Integer, primary_key=True),
     #    Column("user_name", String(16), nullable=False),

samples/table_update_row.py

@@ -10,7 +10,7 @@ def update_row(table):
 
     # TODO(developer): Create the table
     # table = Table(
-    #    table_id,
+    #    table_name,
     #    metadata,
     #    Column("user_id", Integer, primary_key=True),
     #    Column("user_name", String(16), nullable=False),