3079061ae0
* Fixes sphinx format issues in several docstrings * Adds cafe sphinx .rst source files * Converts docstrings in modules with sphinx errors from epydoc format to sphinx format. * Various pep8 fixes in touched files Change-Id: Ie2047c43285a29acfed2d014d1dc4858a20b1f9b
130 lines
4.3 KiB
Python
130 lines
4.3 KiB
Python
# Copyright 2015 Rackspace
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
from cafe.engine.clients.base import BaseClient
|
|
from cafe.common.reporting import cclogging
|
|
|
|
|
|
class SQLClientException(Exception):
|
|
pass
|
|
|
|
|
|
class BaseSQLClient(BaseClient):
|
|
"""
|
|
Base support client for DBAPI 2.0 clients.
|
|
|
|
This client is not meant to be used directly. New clients will extend this
|
|
client and live inside of the individual CAFE.
|
|
|
|
For more information on the DBAPI 2.0 standard please visit:
|
|
.. seealso:: http://www.python.org/dev/peps/pep-0249
|
|
"""
|
|
|
|
_log = cclogging.getLogger(__name__)
|
|
_driver = None
|
|
_connection = None
|
|
|
|
def connect(self, data_source_name=None, user=None, password=None,
|
|
host=None, database=None):
|
|
"""
|
|
Connects to self._driver with passed parameters
|
|
|
|
:param data_source_name: The data source name
|
|
:type data_source_name: string
|
|
:param user: Username
|
|
:type user: string
|
|
:param password: Password
|
|
:type password: string
|
|
:param host: Hostname
|
|
:type host: string
|
|
:param database: Database Name
|
|
:type database: string
|
|
"""
|
|
if self._driver is None:
|
|
message = 'Driver not set.'
|
|
self._log.critical(message)
|
|
raise SQLClientException(message)
|
|
|
|
try:
|
|
self._connection = self._driver.connect(
|
|
data_source_name, user, password, host, database)
|
|
except AttributeError as detail:
|
|
message = "No connect method found in self._driver module."
|
|
self._log.exception(detail)
|
|
self._log.critical(message)
|
|
raise detail
|
|
|
|
def execute(self, operation, parameters=None, cursor=None):
|
|
"""
|
|
Calls execute with operation & parameters sent in on either the passed
|
|
cursor or a new cursor
|
|
|
|
For more information on the execute command see:
|
|
http://www.python.org/dev/peps/pep-0249/#id15
|
|
|
|
:param operation: The operation being executed
|
|
:type operation: string
|
|
:param parameters: Sequence or map that wil be bound to variables in
|
|
the operation
|
|
:type parameters: string or dictionary
|
|
:param cursor: A pre-existing cursor
|
|
:type cursor: cursor object
|
|
"""
|
|
if self._connection is None:
|
|
message = 'Connection not set.'
|
|
self._log.critical(message)
|
|
raise SQLClientException(message)
|
|
|
|
if cursor is None:
|
|
cursor = self._connection.cursor()
|
|
|
|
cursor.execute(operation, parameters)
|
|
|
|
return cursor
|
|
|
|
def execute_many(self, operation, seq_of_parameters=None, cursor=None):
|
|
"""
|
|
Calls executemany with operation & parameters sent in on either the
|
|
passed cursor or a new cursor
|
|
|
|
For more information on the execute command see:
|
|
http://www.python.org/dev/peps/pep-0249/#executemany
|
|
|
|
:param operation: The operation being executed
|
|
:type operation: string
|
|
:param seq_of_parameters: The sequence or mappings that will be run
|
|
against the operation
|
|
:type seq_of_parameters: string or object
|
|
:param cursor: A pre-existing cursor
|
|
:type cursor: cursor object
|
|
"""
|
|
if self._connection is None:
|
|
message = 'Connection not set.'
|
|
self._log.critical(message)
|
|
raise SQLClientException(message)
|
|
|
|
if cursor is None:
|
|
cursor = self._connection.cursor()
|
|
|
|
cursor.executemany(operation, seq_of_parameters)
|
|
|
|
return cursor
|
|
|
|
def close(self):
|
|
"""
|
|
Closes the connection
|
|
"""
|
|
if self._connection is not None:
|
|
self._connection.close()
|
|
self._connection = None
|