Upgrade pyqldb to v2.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

Author: saumehta9

LICENSE

@@ -4,11 +4,11 @@ SPDX-License-Identifier: MIT-0
 Permission is hereby granted, free of charge, to any person obtaining a copy of this
 software and associated documentation files (the "Software"), to deal in the Software
 without restriction, including without limitation the rights to use, copy, modify,
-erge, publish, distribute, sublicense, and/or sell copies of the Software, and to
+merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
 permit persons to whom the Software is furnished to do so.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
-NCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
 PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE

README.md

@@ -47,6 +47,12 @@ $ 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.

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-rc.2'
+__version__ = '1.0.0'

pyqldbsamples/add_secondary_owner.py

@@ -31,7 +31,7 @@ def get_document_id_by_gov_id(transaction_executor, government_id):
     """
     Find a driver's person ID using the given government ID.
 
-    :type transaction_executor: :py:class:`pyqldb.session.executor.Executor`
+    :type transaction_executor: :py:class:`pyqldb.execution.executor.Executor`
     :param transaction_executor: An Executor object allowing for execution of statements within a transaction.
 
     :type government_id: str
@@ -48,7 +48,7 @@ def is_secondary_owner_for_vehicle(transaction_executor, vin, secondary_owner_id
     """
     Check whether a secondary owner has already been registered for the given VIN.
 
-    :type transaction_executor: :py:class:`pyqldb.session.executor.Executor`
+    :type transaction_executor: :py:class:`pyqldb.execution.executor.Executor`
     :param transaction_executor: An Executor object allowing for execution of statements within a transaction.
 
     :type vin: str
@@ -62,8 +62,7 @@ def is_secondary_owner_for_vehicle(transaction_executor, vin, secondary_owner_id
     """
     logger.info('Finding secondary owners for vehicle with VIN: {}...'.format(vin))
     query = 'SELECT Owners.SecondaryOwners FROM VehicleRegistration AS v WHERE v.VIN = ?'
-    parameters = [convert_object_to_ion(vin)]
-    rows = transaction_executor.execute_statement(query, parameters)
+    rows = transaction_executor.execute_statement(query, convert_object_to_ion(vin))
 
     for row in rows:
         secondary_owners = row.get('SecondaryOwners')
@@ -73,23 +72,25 @@ def is_secondary_owner_for_vehicle(transaction_executor, vin, secondary_owner_id
     return False
 
 
-def add_secondary_owner_for_vin(transaction_executor, vin, parameters):
+def add_secondary_owner_for_vin(transaction_executor, vin, parameter):
     """
     Add a secondary owner into `VehicleRegistration` table for a particular VIN.
 
-    :type transaction_executor: :py:class:`pyqldb.session.executor.Executor`
+    :type transaction_executor: :py:class:`pyqldb.execution.executor.Executor`
     :param transaction_executor: An Executor object allowing for execution of statements within a transaction.
 
     :type vin: str
     :param vin: VIN of the vehicle to add a secondary owner for.
 
-    :type parameters: list
-    :param parameters: list of parameters in Ion format.
+    :type parameter: :py:class:`amazon.ion.simple_types.IonPyValue`
+    :param parameter: The Ion value or Python native type that is convertible to Ion for filling in parameters of the
+                      statement.
     """
     logger.info('Inserting secondary owner for vehicle with VIN: {}...'.format(vin))
-    statement = "FROM VehicleRegistration AS v WHERE v.VIN = '{}' INSERT INTO v.Owners.SecondaryOwners VALUE ?".format(vin)
+    statement = "FROM VehicleRegistration AS v WHERE v.VIN = '{}' INSERT INTO v.Owners.SecondaryOwners VALUE ?"\
+        .format(vin)
 
-    cursor = transaction_executor.execute_statement(statement, parameters)
+    cursor = transaction_executor.execute_statement(statement, parameter)
     logger.info('VehicleRegistration Document IDs which had secondary owners added: ')
     print_result(cursor)
 
@@ -98,7 +99,7 @@ def register_secondary_owner(transaction_executor, vin, gov_id):
     """
     Register a secondary owner for a vehicle if they are not already registered.
 
-    :type transaction_executor: :py:class:`pyqldb.session.executor.Executor`
+    :type transaction_executor: :py:class:`pyqldb.execution.executor.Executor`
     :param transaction_executor: An Executor object allowing for execution of statements within a transaction.
 
     :type vin: str
@@ -114,7 +115,7 @@ def register_secondary_owner(transaction_executor, vin, gov_id):
         if is_secondary_owner_for_vehicle(transaction_executor, vin, document_id):
             logger.info('Person with ID {} has already been added as a secondary owner of this vehicle.'.format(gov_id))
         else:
-            add_secondary_owner_for_vin(transaction_executor, vin, [to_ion_struct('PersonId', document_id)])
+            add_secondary_owner_for_vin(transaction_executor, vin, to_ion_struct('PersonId', document_id))
 
 
 if __name__ == '__main__':

pyqldbsamples/connect_to_ledger.py

@@ -46,7 +46,7 @@ def create_qldb_driver(ledger_name=Constants.LEDGER_NAME, region_name=None, endp
     :rtype: :py:class:`pyqldb.driver.pooled_qldb_driver.PooledQldbDriver`
     :return: A pooled QLDB driver object.
 
-    [1] https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html#boto3.session.Session.client
+    [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)

pyqldbsamples/create_index.py

@@ -29,7 +29,7 @@ def create_index(transaction_executor, table_name, index_attribute):
     """
     Create an index for a particular table.
 
-    :type transaction_executor: :py:class:`pyqldb.session.executor.Executor`
+    :type transaction_executor: :py:class:`pyqldb.execution.executor.Executor`
     :param transaction_executor: An Executor object allowing for execution of statements within a transaction.
 
     :type table_name: str

pyqldbsamples/create_table.py

@@ -29,7 +29,7 @@ def create_table(transaction_executor, table_name):
     """
     Create a table with the specified name using an Executor object.
 
-    :type transaction_executor: :py:class:`pyqldb.session.executor.Executor`
+    :type transaction_executor: :py:class:`pyqldb.execution.executor.Executor`
     :param transaction_executor: An Executor object allowing for execution of statements within a transaction.
 
     :type table_name: str

pyqldbsamples/deregister_drivers_license.py

@@ -29,15 +29,15 @@ def deregister_drivers_license(transaction_executor, license_number):
     """
     De-register a driver's license with the given license number.
 
-    :type transaction_executor: :py:class:`pyqldb.session.executor.Executor`
+    :type transaction_executor: :py:class:`pyqldb.execution.executor.Executor`
     :param transaction_executor: An Executor object allowing for execution of statements within a transaction.
 
     :type license_number: str
     :param license_number: The license number of the driver's license to de-register.
     """
     logger.info('De-registering license with license number: {}.'.format(license_number))
     statement = 'DELETE FROM DriversLicense AS d WHERE d.LicenseNumber = ?'
-    parameter = [convert_object_to_ion(license_number)]
+    parameter = convert_object_to_ion(license_number)
     cursor = transaction_executor.execute_statement(statement, parameter)
 
     try:

pyqldbsamples/find_vehicles.py

@@ -30,7 +30,7 @@ def find_vehicles_for_owner(transaction_executor, gov_id):
     """
     Find vehicles registered under a driver using their government ID.
 
-    :type transaction_executor: :py:class:`pyqldb.session.executor.Executor`
+    :type transaction_executor: :py:class:`pyqldb.execution.executor.Executor`
     :param transaction_executor: An Executor object allowing for execution of statements within a transaction.
 
     :type gov_id: str
@@ -42,7 +42,7 @@ def find_vehicles_for_owner(transaction_executor, gov_id):
             "ON Vehicle.VIN = r.VIN WHERE r.Owners.PrimaryOwner.PersonId = ?"
 
     for ids in document_ids:
-        cursor = transaction_executor.execute_statement(query, [ids])
+        cursor = transaction_executor.execute_statement(query, ids)
         logger.info('List of Vehicles for owner with GovId: {}...'.format(gov_id))
         print_result(cursor)
 

pyqldbsamples/insert_document.py

@@ -50,7 +50,7 @@ def insert_documents(transaction_executor, table_name, documents):
     """
     Insert the given list of documents into a table in a single transaction.
 
-    :type transaction_executor: :py:class:`pyqldb.session.executor.Executor`
+    :type transaction_executor: :py:class:`pyqldb.execution.executor.Executor`
     :param transaction_executor: An Executor object allowing for execution of statements within a transaction.
 
     :type table_name: str
@@ -64,7 +64,7 @@ def insert_documents(transaction_executor, table_name, documents):
     """
     logger.info('Inserting some documents in the {} table...'.format(table_name))
     statement = 'INSERT INTO {} ?'.format(table_name)
-    cursor = transaction_executor.execute_statement(statement, [convert_object_to_ion(documents)])
+    cursor = transaction_executor.execute_statement(statement, convert_object_to_ion(documents))
     list_of_document_ids = get_document_ids_from_dml_results(cursor)
 
     return list_of_document_ids
@@ -74,7 +74,7 @@ def update_and_insert_documents(transaction_executor):
     """
     Handle the insertion of documents and updating PersonIds all in a single transaction.
 
-    :type transaction_executor: :py:class:`pyqldb.session.executor.Executor`
+    :type transaction_executor: :py:class:`pyqldb.execution.executor.Executor`
     :param transaction_executor: An Executor object allowing for execution of statements within a transaction.
     """
     list_ids = insert_documents(transaction_executor, Constants.PERSON_TABLE_NAME, SampleData.PERSON)