From 9ae99cddd5b0aad7ecbe62ad533779d762a2987f Mon Sep 17 00:00:00 2001 From: Georg Richter Date: Sun, 3 Apr 2022 18:38:48 +0200 Subject: [PATCH] - Documentation fixes - removed COMMAND constants --- mariadb/constants/CLIENT.py | 5 ++++- mariadb/constants/COMMAND.py | 36 --------------------------------- mariadb/constants/FIELD_FLAG.py | 7 +++++-- mariadb/constants/FIELD_TYPE.py | 11 +++++----- 4 files changed, 15 insertions(+), 44 deletions(-) delete mode 100644 mariadb/constants/COMMAND.py diff --git a/mariadb/constants/CLIENT.py b/mariadb/constants/CLIENT.py index f42c051..9eaf188 100644 --- a/mariadb/constants/CLIENT.py +++ b/mariadb/constants/CLIENT.py @@ -1,7 +1,10 @@ -''' MariaDB client flags +''' +MariaDB client flags (internal use only). These flags are used when establishing a connection to a MariaDB database server or to check the capabilities of a MariaDB server. + +Client flags are defined in module *mariadb.constants.CLIENT_FLAG* ''' MYSQL = 1 # MariaDB diff --git a/mariadb/constants/COMMAND.py b/mariadb/constants/COMMAND.py deleted file mode 100644 index 69adde0..0000000 --- a/mariadb/constants/COMMAND.py +++ /dev/null @@ -1,36 +0,0 @@ -""" -Server commands -""" -SLEEP=0 -QUIT=1 -INIT_DB=2 -QUERY=3 -FIELD_LIST=4 -CREATE_DB=5 -DROP_DB=6 -REFRESH=7 -SHUTDOWN=8 -STATISTICS=9 -PROCESS_INFO=10 -CONNECT=11 -PROCESS_KILL=12 -DEBUG=13 -PING=14 -TIME=15 -DELAYED_INSERT=16 -CHANGE_USER=17 -BINLOG_DUMP=18 -TABLE_DUMP=19 -CONNECT_OUT = 20, -REGISTER_SLAVE=21 -STMT_PREPARE = 22 -STMT_EXECUTE = 23 -STMT_SEND_LONG_DATA = 24 -STMT_CLOSE = 25 -STMT_RESET = 26 -SET_OPTION = 27 -STMT_FETCH = 28 -DAEMON= 29 -UNSUPPORTED= 30 -RESET_CONNECTION = 31 -STMT_BULK_EXECUTE = 250 diff --git a/mariadb/constants/FIELD_FLAG.py b/mariadb/constants/FIELD_FLAG.py index 3d64a7e..57f9299 100644 --- a/mariadb/constants/FIELD_FLAG.py +++ b/mariadb/constants/FIELD_FLAG.py @@ -1,7 +1,10 @@ """MariaDB FIELD_FLAG Constants -These constants represent the various field flags that are -supported by MariaDB. +These constants represent the various field flags. As an addition +to the DBAPI 2.0 standard (PEP-249) these flags are returned as +eigth element of the cursor description attribute. + +Field flags are defined in module *mariadb.constants.FIELD_FLAG* """ # Source: mariadb_com.h (MariaDB Connector(C) diff --git a/mariadb/constants/FIELD_TYPE.py b/mariadb/constants/FIELD_TYPE.py index 6dc5926..674d60e 100644 --- a/mariadb/constants/FIELD_TYPE.py +++ b/mariadb/constants/FIELD_TYPE.py @@ -1,10 +1,11 @@ -"""MariaDB FIELD_TYPE Constants - -These constants represent the various field types that are -supported by MariaDB. """ +MariaDB FIELD_TYPE Constants + +These constants represent the field types supported by MariaDB. +The field type is returned as second element of cursor description attribute. -# Source: mariadb_com.h (MariaDB Connector(C) +Field types are defined in module *mariadb.constants.FIELD_TYPE* +""" DECIMAL = 0 TINY = 1