chore: unit test coverage and additional refactoring for spanner_dbapi
#532
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,159 @@ | ||
| # 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 | ||
|
|
||
| from google.cloud.spanner_dbapi.parse_utils import get_param_types | ||
| from google.cloud.spanner_dbapi.parse_utils import parse_insert | ||
| from google.cloud.spanner_dbapi.parse_utils import sql_pyformat_args_to_spanner | ||
| from google.cloud.spanner_v1 import param_types | ||
|
|
||
|
|
||
| SQL_LIST_TABLES = """ | ||
| SELECT | ||
| t.table_name | ||
| FROM | ||
| information_schema.tables AS t | ||
| WHERE | ||
| t.table_catalog = '' and t.table_schema = '' | ||
| """ | ||
|
|
||
| SQL_GET_TABLE_COLUMN_SCHEMA = """SELECT | ||
| COLUMN_NAME, IS_NULLABLE, SPANNER_TYPE | ||
| FROM | ||
| INFORMATION_SCHEMA.COLUMNS | ||
| WHERE | ||
| TABLE_SCHEMA = '' | ||
| AND | ||
| TABLE_NAME = @table_name | ||
| """ | ||
|
|
||
| # This table maps spanner_types to Spanner's data type sizes as per | ||
| # https://cloud.google.com/spanner/docs/data-types#allowable-types | ||
| # It is used to map `display_size` to a known type for Cursor.description | ||
| # after a row fetch. | ||
| # Since ResultMetadata | ||
| # https://cloud.google.com/spanner/docs/reference/rest/v1/ResultSetMetadata | ||
| # does not send back the actual size, we have to lookup the respective size. | ||
| # Some fields' sizes are dependent upon the dynamic data hence aren't sent back | ||
| # by Cloud Spanner. | ||
| code_to_display_size = { | ||
| param_types.BOOL.code: 1, | ||
| param_types.DATE.code: 4, | ||
| param_types.FLOAT64.code: 8, | ||
| param_types.INT64.code: 8, | ||
| param_types.TIMESTAMP.code: 12, | ||
| } | ||
|
|
||
|
|
||
| def _execute_insert_heterogenous(transaction, sql_params_list): | ||
| for sql, params in sql_params_list: | ||
| sql, params = sql_pyformat_args_to_spanner(sql, params) | ||
| param_types = get_param_types(params) | ||
| res = transaction.execute_sql( | ||
| sql, params=params, param_types=param_types | ||
| ) | ||
| # TODO: File a bug with Cloud Spanner and the Python client maintainers | ||
| # about a lost commit when res isn't read from. | ||
|
Comment on lines
+57
to
+58
There was a problem hiding this comment. I know your change just moved this comment, but I wonder what the story is here. There was a problem hiding this comment. It would be a good question for the original code developer who unfortunately is no longer a member of our team. I'm not even sure what's the purpose of |
||
| _ = list(res) | ||
|
|
||
|
|
||
| def _execute_insert_homogenous(transaction, parts): | ||
| # Perform an insert in one shot. | ||
| table = parts.get("table") | ||
| columns = parts.get("columns") | ||
| values = parts.get("values") | ||
| return transaction.insert(table, columns, values) | ||
|
|
||
|
|
||
| def handle_insert(connection, sql, params): | ||
| parts = parse_insert(sql, params) | ||
|
|
||
| # The split between the two styles exists because: | ||
| # in the common case of multiple values being passed | ||
| # with simple pyformat arguments, | ||
| # SQL: INSERT INTO T (f1, f2) VALUES (%s, %s, %s) | ||
| # Params: [(1, 2, 3, 4, 5, 6, 7, 8, 9, 10,)] | ||
| # we can take advantage of a single RPC with: | ||
| # transaction.insert(table, columns, values) | ||
| # instead of invoking: | ||
| # with transaction: | ||
| # for sql, params in sql_params_list: | ||
| # transaction.execute_sql(sql, params, param_types) | ||
| # which invokes more RPCs and is more costly. | ||
|
|
||
| if parts.get("homogenous"): | ||
| # The common case of multiple values being passed in | ||
| # non-complex pyformat args and need to be uploaded in one RPC. | ||
| return connection.database.run_in_transaction( | ||
| _execute_insert_homogenous, parts | ||
| ) | ||
| else: | ||
| # All the other cases that are esoteric and need | ||
| # transaction.execute_sql | ||
| sql_params_list = parts.get("sql_params_list") | ||
| return connection.database.run_in_transaction( | ||
| _execute_insert_heterogenous, sql_params_list | ||
| ) | ||
|
|
||
|
|
||
| class ColumnInfo: | ||
| """Row column description object.""" | ||
|
|
||
| def __init__( | ||
| self, | ||
| name, | ||
| type_code, | ||
| display_size=None, | ||
| internal_size=None, | ||
| precision=None, | ||
| scale=None, | ||
| null_ok=False, | ||
| ): | ||
| self.name = name | ||
| self.type_code = type_code | ||
| self.display_size = display_size | ||
| self.internal_size = internal_size | ||
| self.precision = precision | ||
| self.scale = scale | ||
| self.null_ok = null_ok | ||
|
|
||
| self.fields = ( | ||
| self.name, | ||
| self.type_code, | ||
| self.display_size, | ||
| self.internal_size, | ||
| self.precision, | ||
| self.scale, | ||
| self.null_ok, | ||
| ) | ||
|
|
||
| def __repr__(self): | ||
| return self.__str__() | ||
|
|
||
| def __getitem__(self, index): | ||
| return self.fields[index] | ||
|
|
||
| def __str__(self): | ||
| str_repr = ", ".join( | ||
| filter( | ||
| lambda part: part is not None, | ||
| [ | ||
| "name='%s'" % self.name, | ||
| "type_code=%d" % self.type_code, | ||
| "display_size=%d" % self.display_size | ||
| if self.display_size | ||
| else None, | ||
| "internal_size=%d" % self.internal_size | ||
| if self.internal_size | ||
| else None, | ||
| "precision='%s'" % self.precision | ||
| if self.precision | ||
| else None, | ||
| "scale='%s'" % self.scale if self.scale else None, | ||
| "null_ok='%s'" % self.null_ok if self.null_ok else None, | ||
| ], | ||
| ) | ||
| ) | ||
| return "ColumnInfo(%s)" % str_repr | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FWIW our current isort config will mangle this formatting. Did you do this by hand?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, I did. It would work either way, and was more of the matter of a consistent visual appearance.