3 (È\…ã@sddZddlmZmZmZddlZddlmZejeƒGdd„de ƒƒZ ejeƒGdd „d e ƒƒZ dS) z2Implement the Base class for Driver and Connectioné)ÚABCMetaÚabstractmethodÚabstractpropertyNé)ÚDriverRegistryc@sLeZdZdZedd„ƒZedd„ƒZedd„ƒZedd „ƒZ ed d „ƒZ d S) Ú BaseDrivera§ class BaseDriver(object): This is a base class for different server types. Inherit this class to implement different type of database driver implementation. (For PostgreSQL/EDB Postgres Advanced Server, we will be using psycopg2) Abstract Properties: -------- ---------- * Version (string): Current version string for the database server * libpq_version (string): Current version string for the used libpq library Abstract Methods: -------- ------- * get_connection(*args, **kwargs) - It should return a Connection class object, which may/may not be connected to the database server. * release_connection(*args, **kwargs) - Implement the connection release logic * gc() - Implement this function to release the connections assigned in the session, which has not been pinged from more than the idle timeout configuration. cCsdS)N©)Úclsrrú8/usr/share/pgadmin4/web/pgadmin/utils/driver/abstract.pyÚVersion5szBaseDriver.VersioncCsdS)Nr)r rrr Ú libpq_version9szBaseDriver.libpq_versioncOsdS)Nr)ÚselfÚargsÚkwargsrrr Úget_connection=szBaseDriver.get_connectioncOsdS)Nr)r rrrrr Úrelease_connectionAszBaseDriver.release_connectioncCsdS)Nr)r rrr ÚgcEsz BaseDriver.gcN) Ú__name__Ú __module__Ú __qualname__Ú__doc__rr r rrrrrrrr rs      rc@seZdZdZdZdZdZdZdZdZ dZ dZ e d d „ƒZ e d0d d„ƒZe d1dd„ƒZe d2dd„ƒZe d3dd„ƒZe d4dd„ƒZe d6dd„ƒZe dd„ƒZe dd„ƒZe dd„ƒZe d d!„ƒZe d"d#„ƒZe d$d%„ƒZe d&d'„ƒZe d7d(d)„ƒZe d*d+„ƒZe d,d-„ƒZe d8d.d/„ƒZd S)9ÚBaseConnectionaß class BaseConnection(object) It is a base class for database connection. A different connection drive must implement this to expose abstract methods for this server. General idea is to create a wrapper around the actual driver implementation. It will be instantiated by the driver factory basically. And, they should not be instantiated directly. Abstract Methods: -------- ------- * connect(**kwargs) - Define this method to connect the server using that particular driver implementation. * execute_scalar(query, params, formatted_exception_msg) - Implement this method to execute the given query and returns single datum result. * execute_async(query, params, formatted_exception_msg) - Implement this method to execute the given query asynchronously and returns result. * execute_void(query, params, formatted_exception_msg) - Implement this method to execute the given query with no result. * execute_2darray(query, params, formatted_exception_msg) - Implement this method to execute the given query and returns the result as a 2 dimensional array. * execute_dict(query, params, formatted_exception_msg) - Implement this method to execute the given query and returns the result as an array of dict (column name -> value) format. * def async_fetchmany_2darray(records=-1, formatted_exception_msg=False): - Implement this method to retrieve result of asynchronous connection and polling with no_result flag set to True. This returns the result as a 2 dimensional array. If records is -1 then fetchmany will behave as fetchall. * connected() - Implement this method to get the status of the connection. It should return True for connected, otherwise False * reset() - Implement this method to reconnect the database server (if possible) * transaction_status() - Implement this method to get the transaction status for this connection. Range of return values different for each driver type. * ping() - Implement this method to ping the server. There are times, a connection has been lost, but - the connection driver does not know about it. This can be helpful to figure out the actual reason for query failure. * _release() - Implement this method to release the connection object. This should not be directly called using the connection object itself. NOTE: Please use BaseDriver.release_connection(...) for releasing the connection object for better memory management, and connection pool management. * _wait(conn) - Implement this method to wait for asynchronous connection to finish the execution, hence - it must be a blocking call. * _wait_timeout(conn, time) - Implement this method to wait for asynchronous connection with timeout. This must be a non blocking call. * poll(formatted_exception_msg, no_result) - Implement this method to poll the data of query running on asynchronous connection. * cancel_transaction(conn_id, did=None) - Implement this method to cancel the running transaction. * messages() - Implement this method to return the list of the messages/notices from the database server. * rows_affected() - Implement this method to get the rows affected by the last command executed on the server. réééégš™™™™™É?i †cKsdS)Nr)r rrrr Úconnect¯szBaseConnection.connectNFcCsdS)Nr)r ÚqueryÚparamsÚformatted_exception_msgrrr Úexecute_scalar³szBaseConnection.execute_scalarTcCsdS)Nr)r rrrrrr Ú execute_async¸szBaseConnection.execute_asynccCsdS)Nr)r rrrrrr Ú execute_void½szBaseConnection.execute_voidcCsdS)Nr)r rrrrrr Úexecute_2darrayÂszBaseConnection.execute_2darraycCsdS)Nr)r rrrrrr Ú execute_dictÇszBaseConnection.execute_dictcCsdS)Nr)r Zrecordsrrrr Úasync_fetchmany_2darrayÌsz&BaseConnection.async_fetchmany_2darraycCsdS)Nr)r rrr Ú connectedÑszBaseConnection.connectedcCsdS)Nr)r rrr ÚresetÕszBaseConnection.resetcCsdS)Nr)r rrr Útransaction_statusÙsz!BaseConnection.transaction_statuscCsdS)Nr)r rrr ÚpingÝszBaseConnection.pingcCsdS)Nr)r rrr Ú_releaseászBaseConnection._releasecCsdS)Nr)r Úconnrrr Ú_waitåszBaseConnection._waitcCsdS)Nr)r r+Ztimerrr Ú _wait_timeoutészBaseConnection._wait_timeoutcCsdS)Nr)r rZ no_resultrrr ÚpollíszBaseConnection.pollcCsdS)Nr)r rrr Ústatus_messageñszBaseConnection.status_messagecCsdS)Nr)r rrr Ú rows_affectedõszBaseConnection.rows_affectedcCsdS)Nr)r Zconn_idZdidrrr Úcancel_transactionùsz!BaseConnection.cancel_transaction)NF)NT)NF)NF)NFéÿÿÿÿ)r2F)TF)N)rrrrZASYNC_OKZASYNC_READ_TIMEOUTZASYNC_WRITE_TIMEOUTZASYNC_NOT_CONNECTEDZASYNC_EXECUTION_ABORTEDZ ASYNC_TIMEOUTZASYNC_WAIT_TIMEOUTZASYNC_NOTICE_MAXLENGTHrrr r!r"r#r$r%r&r'r(r)r*r,r-r.r/r0r1rrrr rJsRZ                 r) rÚabcrrrZsixÚregistryrZ add_metaclassÚobjectrrrrrr Ú s 6