Upgrade Pyqldb to version 3.0.0rc1

Author: Saurabh

CHANGELOG.md

@@ -0,0 +1,16 @@
+### Release 2.0.0-rc.1
+* Upgraded Pyqldb version from 2.0.0 to 3.0.0-rc.1
+
+### Release 1.0.0
+
+* Upgraded pyqldb version from v1.0.0-rc.2 to 2.0.0
+* Used args for execute_statement instead of a list
+* Added examples for native python data types
+
+### Release 1.0.0-rc.2
+
+* Fixes for small documentation issues.
+
+### Release 1.0.0-rc.1
+
+* Initial preview release of the QLDB Python Sample Application.

README.md

@@ -47,20 +47,6 @@ $ cd docs
 $ make html
 ```
 
-### Release 1.0.0
-
-* Upgraded pyqldb version from v1.0.0-rc.2 to 2.0.0
-* Used args for execute_statement instead of a list
-* Added examples for native python data types
-
-### Release 1.0.0-rc.2 (October 29, 2019)
-
-* Fixes for small documentation issues.
-
-### Release 1.0.0-rc.1 (October 28, 2019)
-
-* Initial preview release of the QLDB Python Sample Application.
-
 ## License
 
 This library is licensed under the MIT-0 License.

pyqldbsamples/__init__.py

@@ -14,4 +14,4 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-__version__ = '1.0.0'
+__version__ = '2.0.0-rc.1'

pyqldbsamples/add_secondary_owner.py

@@ -21,7 +21,7 @@
 from pyqldbsamples.model.sample_data import to_ion_struct, get_document_ids, print_result, SampleData, \
     convert_object_to_ion
 from pyqldbsamples.constants import Constants
-from pyqldbsamples.connect_to_ledger import create_qldb_session
+from pyqldbsamples.connect_to_ledger import create_qldb_driver
 
 logger = getLogger(__name__)
 basicConfig(level=INFO)
@@ -125,8 +125,8 @@ def register_secondary_owner(transaction_executor, vin, gov_id):
     vin = SampleData.VEHICLE[1]['VIN']
     gov_id = SampleData.PERSON[0]['GovId']
     try:
-        with create_qldb_session() as session:
-            session.execute_lambda(lambda executor: register_secondary_owner(executor, vin, gov_id),
+        with create_qldb_driver() as driver:
+            driver.execute_lambda(lambda executor: register_secondary_owner(executor, vin, gov_id),
                                    lambda retry_attempt: logger.info('Retrying due to OCC conflict...'))
             logger.info('Secondary owners successfully updated.')
     except Exception:

pyqldbsamples/connect_to_ledger.py

@@ -20,7 +20,7 @@
 
 from botocore.exceptions import ClientError
 
-from pyqldb.driver.pooled_qldb_driver import PooledQldbDriver
+from pyqldb.driver.qldb_driver import QldbDriver
 from pyqldbsamples.constants import Constants
 
 logger = getLogger(__name__)
@@ -29,7 +29,7 @@
 
 def create_qldb_driver(ledger_name=Constants.LEDGER_NAME, region_name=None, endpoint_url=None, boto3_session=None):
     """
-    Create a QLDB driver for creating sessions.
+    Create a QLDB driver for executing transactions.
 
     :type ledger_name: str
     :param ledger_name: The QLDB ledger name.
@@ -43,38 +43,24 @@ def create_qldb_driver(ledger_name=Constants.LEDGER_NAME, region_name=None, endp
     :type boto3_session: :py:class:`boto3.session.Session`
     :param boto3_session: The boto3 session to create the client with (see [1]).
 
-    :rtype: :py:class:`pyqldb.driver.pooled_qldb_driver.PooledQldbDriver`
-    :return: A pooled QLDB driver object.
+    :rtype: :py:class:`pyqldb.driver.qldb_driver.QldbDriver`
+    :return: A QLDB driver object.
 
     [1]: `Boto3 Session.client Reference <https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html#boto3.session.Session.client>`.
     """
-    qldb_driver = PooledQldbDriver(ledger_name=ledger_name, region_name=region_name, endpoint_url=endpoint_url,
-                                   boto3_session=boto3_session)
+    qldb_driver = QldbDriver(ledger_name=ledger_name, region_name=region_name, endpoint_url=endpoint_url,
+                             boto3_session=boto3_session)
     return qldb_driver
 
 
-def create_qldb_session():
-    """
-    Retrieve a QLDB session object.
-
-    :rtype: :py:class:`pyqldb.session.pooled_qldb_session.PooledQldbSession`
-    :return: A pooled QLDB session object.
-    """
-    qldb_session = pooled_qldb_driver.get_session()
-    return qldb_session
-
-
-pooled_qldb_driver = create_qldb_driver()
-
-
 if __name__ == '__main__':
     """
-    Connect to a session for a given ledger using default settings.
+    Connect to a given ledger using default settings.
     """
     try:
-        qldb_session = create_qldb_session()
-        logger.info('Listing table names ')
-        for table in qldb_session.list_tables():
-            logger.info(table)
+        with create_qldb_driver() as driver:
+            logger.info('Listing table names ')
+            for table in driver.list_tables():
+                logger.info(table)
     except ClientError:
-        logger.exception('Unable to create session.')
+        logger.exception('Unable to list tables.')

pyqldbsamples/create_index.py

@@ -19,7 +19,7 @@
 from logging import basicConfig, getLogger, INFO
 
 from pyqldbsamples.constants import Constants
-from pyqldbsamples.connect_to_ledger import create_qldb_session
+from pyqldbsamples.connect_to_ledger import create_qldb_driver
 
 logger = getLogger(__name__)
 basicConfig(level=INFO)
@@ -53,8 +53,8 @@ def create_index(transaction_executor, table_name, index_attribute):
     """
     logger.info('Creating indexes on all tables in a single transaction...')
     try:
-        with create_qldb_session() as session:
-            session.execute_lambda(lambda x: create_index(x, Constants.PERSON_TABLE_NAME,
+        with create_qldb_driver() as driver:
+            driver.execute_lambda(lambda x: create_index(x, Constants.PERSON_TABLE_NAME,
                                                           Constants.GOV_ID_INDEX_NAME)
                                    and create_index(x, Constants.VEHICLE_TABLE_NAME,
                                                     Constants.VEHICLE_VIN_INDEX_NAME)

pyqldbsamples/create_table.py

@@ -19,7 +19,7 @@
 from logging import basicConfig, getLogger, INFO
 
 from pyqldbsamples.constants import Constants
-from pyqldbsamples.connect_to_ledger import create_qldb_session
+from pyqldbsamples.connect_to_ledger import create_qldb_driver
 
 logger = getLogger(__name__)
 basicConfig(level=INFO)
@@ -50,8 +50,8 @@ def create_table(transaction_executor, table_name):
     Create registrations, vehicles, owners, and licenses tables in a single transaction.
     """
     try:
-        with create_qldb_session() as session:
-            session.execute_lambda(lambda x: create_table(x, Constants.DRIVERS_LICENSE_TABLE_NAME) and
+        with create_qldb_driver() as qldb_driver:
+            qldb_driver.execute_lambda(lambda x: create_table(x, Constants.DRIVERS_LICENSE_TABLE_NAME) and
                                    create_table(x, Constants.PERSON_TABLE_NAME) and
                                    create_table(x, Constants.VEHICLE_TABLE_NAME) and
                                    create_table(x, Constants.VEHICLE_REGISTRATION_TABLE_NAME),

pyqldbsamples/deregister_drivers_license.py

@@ -18,7 +18,7 @@
 # https://boto3.amazonaws.com/v1/documentation/api/latest/guide/quickstart.html
 from logging import basicConfig, getLogger, INFO
 
-from pyqldbsamples.connect_to_ledger import create_qldb_session
+from pyqldbsamples.connect_to_ledger import create_qldb_driver
 from pyqldbsamples.model.sample_data import SampleData, convert_object_to_ion
 
 logger = getLogger(__name__)
@@ -55,8 +55,8 @@ def deregister_drivers_license(transaction_executor, license_number):
     license_number = SampleData.DRIVERS_LICENSE[1]['LicenseNumber']
 
     try:
-        with create_qldb_session() as session:
-            session.execute_lambda(lambda executor: deregister_drivers_license(executor, license_number),
+        with create_qldb_driver() as driver:
+            driver.execute_lambda(lambda executor: deregister_drivers_license(executor, license_number),
                                    lambda retry_attempt: logger.info('Retrying due to OCC conflict...'))
     except Exception:
         logger.exception('Error deleting driver license.')

pyqldbsamples/find_vehicles.py

@@ -20,7 +20,7 @@
 
 from pyqldbsamples.model.sample_data import get_document_ids, print_result, SampleData
 from pyqldbsamples.constants import Constants
-from pyqldbsamples.connect_to_ledger import create_qldb_session
+from pyqldbsamples.connect_to_ledger import create_qldb_driver
 
 logger = getLogger(__name__)
 basicConfig(level=INFO)
@@ -52,10 +52,10 @@ def find_vehicles_for_owner(transaction_executor, gov_id):
     Find all vehicles registered under a person.
     """
     try:
-        with create_qldb_session() as session:
+        with create_qldb_driver() as driver:
             # Find all vehicles registered under a person.
             gov_id = SampleData.PERSON[0]['GovId']
-            session.execute_lambda(lambda executor: find_vehicles_for_owner(executor, gov_id),
+            driver.execute_lambda(lambda executor: find_vehicles_for_owner(executor, gov_id),
                                    lambda retry_attempt: logger.info('Retrying due to OCC conflict...'))
     except Exception:
         logger.exception('Error getting vehicles for owner.')

pyqldbsamples/get_block.py

@@ -26,7 +26,7 @@
 from pyqldbsamples.get_digest import get_digest_result
 from pyqldbsamples.verifier import to_base_64, verify_document, parse_block, flip_random_bit
 from pyqldbsamples.qldb.block_address import block_address_to_dictionary
-from pyqldbsamples.connect_to_ledger import create_qldb_session
+from pyqldbsamples.connect_to_ledger import create_qldb_driver
 from pyqldbsamples.qldb.qldb_string_utils import block_response_to_string, value_holder_to_string
 
 logger = getLogger(__name__)
@@ -147,9 +147,8 @@ def verify_block(ledger_name, block_address):
     """
     vin = SampleData.VEHICLE_REGISTRATION[1]['VIN']
     try:
-        with create_qldb_session() as session:
-            cursor = session.execute_lambda(lambda executor: lookup_registration_for_vin(executor, vin),
-                                            lambda retry_indicator: logger.info('Retrying due to OCC conflict...'))
+        with create_qldb_driver() as driver:
+            cursor = driver.execute_lambda(lambda executor: lookup_registration_for_vin(executor, vin))
             row = next(cursor)
             block_address = row.get('blockAddress')
             verify_block(Constants.LEDGER_NAME, block_address)

pyqldbsamples/get_revision.py

@@ -26,7 +26,7 @@
 from pyqldbsamples.model.sample_data import SampleData, convert_object_to_ion
 from pyqldbsamples.qldb.block_address import block_address_to_dictionary
 from pyqldbsamples.verifier import verify_document, flip_random_bit, to_base_64
-from pyqldbsamples.connect_to_ledger import create_qldb_session
+from pyqldbsamples.connect_to_ledger import create_qldb_driver
 from pyqldbsamples.qldb.qldb_string_utils import value_holder_to_string
 
 logger = getLogger(__name__)
@@ -59,12 +59,12 @@ def get_revision(ledger_name, document_id, block_address, digest_tip_address):
     return result
 
 
-def lookup_registration_for_vin(qldb_session, vin):
+def lookup_registration_for_vin(driver, vin):
     """
     Query revision history for a particular vehicle for verification.
 
-    :type qldb_session: :py:class:`pyqldb.session.qldb_session.QldbSession`
-    :param qldb_session: An instance of the QldbSession class.
+    :type driver: :py:class:`pyqldb.driver.qldb_driver.QldbDriver`
+    :param driver: An instance of the QldbDriver class.
 
     :type vin: str
     :param vin: VIN to query the revision history of a specific registration with.
@@ -75,16 +75,16 @@ def lookup_registration_for_vin(qldb_session, vin):
     logger.info("Querying the 'VehicleRegistration' table for VIN: {}...".format(vin))
     query = 'SELECT * FROM _ql_committed_VehicleRegistration WHERE data.VIN = ?'
     parameters = [convert_object_to_ion(vin)]
-    cursor = qldb_session.execute_statement(query, parameters)
+    cursor = driver.execute_lambda( lambda txn: txn.execute_statement(query, parameters))
     return cursor
 
 
-def verify_registration(qldb_session, ledger_name, vin):
+def verify_registration(driver, ledger_name, vin):
     """
     Verify each version of the registration for the given VIN.
 
-    :type qldb_session: :py:class:`pyqldb.session.qldb_session.QldbSession`
-    :param qldb_session: An instance of the QldbSession class.
+    :type driver: :py:class:`pyqldb.driver.qldb_driver.QldbDriver`
+    :param driver: An instance of the QldbDriver class.
 
     :type ledger_name: str
     :param ledger_name: The ledger to get digest from.
@@ -103,7 +103,7 @@ def verify_registration(qldb_session, ledger_name, vin):
         value_holder_to_string(digest_tip_address.get('IonText')), to_base_64(digest_bytes)))
 
     logger.info('Querying the registration with VIN = {} to verify each version of the registration...'.format(vin))
-    cursor = lookup_registration_for_vin(qldb_session, vin)
+    cursor = lookup_registration_for_vin(driver, vin)
     logger.info('Getting a proof for the document.')
 
     for row in cursor:
@@ -142,7 +142,7 @@ def verify_registration(qldb_session, ledger_name, vin):
     registration = SampleData.VEHICLE_REGISTRATION[0]
     vin = registration['VIN']
     try:
-        with create_qldb_session() as session:
-            verify_registration(session, Constants.LEDGER_NAME, vin)
+        with create_qldb_driver() as driver:
+            verify_registration(driver, Constants.LEDGER_NAME, vin)
     except Exception:
         logger.exception('Unable to verify revision.')

pyqldbsamples/insert_document.py

@@ -20,7 +20,7 @@
 
 from pyqldbsamples.constants import Constants
 from pyqldbsamples.model.sample_data import convert_object_to_ion, SampleData, get_document_ids_from_dml_results
-from pyqldbsamples.connect_to_ledger import create_qldb_session
+from pyqldbsamples.connect_to_ledger import create_qldb_driver
 
 logger = getLogger(__name__)
 basicConfig(level=INFO)
@@ -92,10 +92,10 @@ def update_and_insert_documents(transaction_executor):
     Insert documents into a table in a QLDB ledger.
     """
     try:
-        with create_qldb_session() as session:
+        with create_qldb_driver() as driver:
             # An INSERT statement creates the initial revision of a document with a version number of zero.
             # QLDB also assigns a unique document identifier in GUID format as part of the metadata.
-            session.execute_lambda(lambda executor: update_and_insert_documents(executor),
+            driver.execute_lambda(lambda executor: update_and_insert_documents(executor),
                                    lambda retry_attempt: logger.info('Retrying due to OCC conflict...'))
             logger.info('Documents inserted successfully!')
     except Exception:

pyqldbsamples/insert_ion_types.py

@@ -29,7 +29,7 @@
 from pyqldbsamples.create_table import create_table
 from pyqldbsamples.insert_document import insert_documents
 from pyqldbsamples.model.sample_data import convert_object_to_ion
-from pyqldbsamples.connect_to_ledger import create_qldb_session
+from pyqldbsamples.connect_to_ledger import create_qldb_driver
 
 logger = getLogger(__name__)
 basicConfig(level=INFO)
@@ -95,13 +95,13 @@ def delete_table(transaction_executor, table_name):
     return len(list(cursor))
 
 
-def insert_and_verify_ion_types(session):
+def insert_and_verify_ion_types(driver):
     """
     Insert all the supported Ion types and Python values that are convertible to Ion into a ledger and verify that they
     are stored and can be retrieved properly, retaining their original properties.
 
-    :type session: :py:class:`pyqldb.session.base_qldb_session.BaseQldbSession`
-    :param session: A QLDB session object.
+    :type driver: :py:class:`pyqldb.driver.qldb_driver.QldbDriver`
+    :param driver: A QLDB Driver object.
     """
     python_bytes = str.encode('hello')
     python_bool = True
@@ -141,7 +141,7 @@ def insert_and_verify_ion_types(session):
     ion_null_symbol = convert_object_to_ion(loads('null.symbol'))
     ion_null_timestamp = convert_object_to_ion(loads('null.timestamp'))
 
-    session.execute_lambda(lambda transaction_executor: create_table(transaction_executor, TABLE_NAME)
+    driver.execute_lambda(lambda transaction_executor: create_table(transaction_executor, TABLE_NAME)
                            and insert_documents(transaction_executor, TABLE_NAME, [{'Name': 'val'}])
                            and update_record_and_verify_type(transaction_executor, python_bytes, IonPyBytes,
                                                              IonType.BLOB)
@@ -223,7 +223,7 @@ def insert_and_verify_ion_types(session):
     are stored and can be retrieved properly, retaining their original properties.
     """
     try:
-        with create_qldb_session() as session:
-            insert_and_verify_ion_types(session)
+        with create_qldb_driver() as driver:
+            insert_and_verify_ion_types(driver)
     except Exception:
         logger.exception('Error updating and validating Ion types.')

pyqldbsamples/list_tables.py

@@ -18,7 +18,7 @@
 # https://boto3.amazonaws.com/v1/documentation/api/latest/guide/quickstart.html
 from logging import basicConfig, getLogger, INFO
 
-from pyqldbsamples.connect_to_ledger import create_qldb_session
+from pyqldbsamples.connect_to_ledger import create_qldb_driver
 
 logger = getLogger(__name__)
 basicConfig(level=INFO)
@@ -29,12 +29,12 @@ def list_tables():
     List all tables.
 
     :rtype: list
-    :return: List of ledgers.
+    :return: List of tables.
     """
     logger.info("Let's list all the tables...")
-    with create_qldb_session() as session:
+    with create_qldb_driver() as driver:
         logger.info("Success. List of tables:")
-        tables = session.list_tables()
+        tables = driver.list_tables()
         for table in tables:
             logger.info(table)
     return tables