mysql_metadata.h 13.7 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
/*
  Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.

  The MySQL Connector/C++ is licensed under the terms of the GPLv2
  <http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>, like most
  MySQL Connectors. There are special exceptions to the terms and
  conditions of the GPLv2 as it is applied to this software, see the
  FLOSS License Exception
  <http://www.mysql.com/about/legal/licensing/foss-exception.html>.

  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published
  by the Free Software Foundation; version 2 of the License.

  This program is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
  for more details.

  You should have received a copy of the GNU General Public License along
  with this program; if not, write to the Free Software Foundation, Inc.,
  51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
*/

#ifndef _MYSQL_METADATA_H_
#define _MYSQL_METADATA_H_

#include <boost/shared_ptr.hpp>

#include <cppconn/metadata.h>
#include <map>

namespace sql
{
    class ResultSet;

    namespace mysql
    {

        class MySQL_Connection;
        class MySQL_DebugLogger;

        namespace NativeAPI
        {
            class IMySQLCAPI;
        }


        class MySQL_ConnectionMetaData : public sql::DatabaseMetaData
        {
            MySQL_Connection* connection;
            unsigned long server_version;
            boost::shared_ptr< MySQL_DebugLogger > logger;

            boost::shared_ptr< NativeAPI::NativeConnectionWrapper > proxy;

            sql::SQLString lower_case_table_names;

            bool use_info_schema;
        public:
            MySQL_ConnectionMetaData(MySQL_Connection* const conn, boost::shared_ptr<NativeAPI::NativeConnectionWrapper> _capi,
                                     boost::shared_ptr< MySQL_DebugLogger > & l);

            virtual ~MySQL_ConnectionMetaData();

            bool allProceduresAreCallable();

            bool allTablesAreSelectable();

            bool dataDefinitionCausesTransactionCommit();

            bool dataDefinitionIgnoredInTransactions();

            bool deletesAreDetected(int type);

            bool doesMaxRowSizeIncludeBlobs();

            sql::ResultSet* getAttributes(const sql::SQLString& catalog, const sql::SQLString& schemaPattern, const sql::SQLString& typeNamePattern, const sql::SQLString& attributeNamePattern);

            sql::ResultSet* getBestRowIdentifier(const sql::SQLString& catalog, const sql::SQLString& schema, const sql::SQLString& table, int scope, bool nullable);

            sql::ResultSet* getCatalogs();

            const sql::SQLString& getCatalogSeparator();

            const sql::SQLString& getCatalogTerm();

            sql::ResultSet* getColumnPrivileges(const sql::SQLString& catalog, const sql::SQLString& schema, const sql::SQLString& table, const sql::SQLString& columnNamePattern);

            sql::ResultSet* getColumns(const sql::SQLString& catalog, const sql::SQLString& schemaPattern, const sql::SQLString& tableNamePattern, const sql::SQLString& columnNamePattern);

            sql::Connection* getConnection();

            sql::ResultSet* getCrossReference(const sql::SQLString& primaryCatalog, const sql::SQLString& primarySchema, const sql::SQLString& primaryTable, const sql::SQLString& foreignCatalog, const sql::SQLString& foreignSchema, const sql::SQLString& foreignTable);

            unsigned int getDatabaseMajorVersion();

            unsigned int getDatabaseMinorVersion();

            unsigned int getDatabasePatchVersion();

            const sql::SQLString& getDatabaseProductName();

            SQLString getDatabaseProductVersion();

            int getDefaultTransactionIsolation();

            unsigned int getDriverMajorVersion();

            unsigned int getDriverMinorVersion();

            unsigned int getDriverPatchVersion();

            const sql::SQLString& getDriverName();

            const sql::SQLString& getDriverVersion();

            sql::ResultSet* getExportedKeys(const sql::SQLString& catalog, const sql::SQLString& schema, const sql::SQLString& table);

            const sql::SQLString& getExtraNameCharacters();

            const sql::SQLString& getIdentifierQuoteString();

            sql::ResultSet* getImportedKeys(const sql::SQLString& catalog, const sql::SQLString& schema, const sql::SQLString& table);

            sql::ResultSet* getIndexInfo(const sql::SQLString& catalog, const sql::SQLString& schema, const sql::SQLString& table, bool unique, bool approximate);

            unsigned int getCDBCMajorVersion();

            unsigned int getCDBCMinorVersion();

            unsigned int getMaxBinaryLiteralLength();

            unsigned int getMaxCatalogNameLength();

            unsigned int getMaxCharLiteralLength();

            unsigned int getMaxColumnNameLength();

            unsigned int getMaxColumnsInGroupBy();

            unsigned int getMaxColumnsInIndex();

            unsigned int getMaxColumnsInOrderBy();

            unsigned int getMaxColumnsInSelect();

            unsigned int getMaxColumnsInTable();

            unsigned int getMaxConnections();

            unsigned int getMaxCursorNameLength();

            unsigned int getMaxIndexLength();

            unsigned int getMaxProcedureNameLength();

            unsigned int getMaxRowSize();

            unsigned int getMaxSchemaNameLength();

            unsigned int getMaxStatementLength();

            unsigned int getMaxStatements();

            unsigned int getMaxTableNameLength();

            unsigned int getMaxTablesInSelect();

            unsigned int getMaxUserNameLength();

            const sql::SQLString& getNumericFunctions();

            sql::ResultSet* getPrimaryKeys(const sql::SQLString& catalog, const sql::SQLString& schema, const sql::SQLString& table);

            sql::ResultSet* getProcedureColumns(const sql::SQLString& catalog, const sql::SQLString& schemaPattern, const sql::SQLString& procedureNamePattern, const sql::SQLString& columnNamePattern);

            sql::ResultSet* getProcedures(const sql::SQLString& catalog, const sql::SQLString& schemaPattern, const sql::SQLString& procedureNamePattern);

            const sql::SQLString& getProcedureTerm();

            int getResultSetHoldability();

            sql::ResultSet* getSchemas();

            const sql::SQLString& getSchemaTerm();

            const sql::SQLString& getSearchStringEscape();

            const sql::SQLString& getSQLKeywords();

            int getSQLStateType();

            const sql::SQLString& getStringFunctions();

            sql::ResultSet* getSuperTables(const sql::SQLString& catalog, const sql::SQLString& schemaPattern, const sql::SQLString& tableNamePattern);

            sql::ResultSet* getSuperTypes(const sql::SQLString& catalog, const sql::SQLString& schemaPattern, const sql::SQLString& typeNamePattern);

            const sql::SQLString& getSystemFunctions();

            sql::ResultSet* getTablePrivileges(const sql::SQLString& catalog, const sql::SQLString& schemaPattern, const sql::SQLString& tableNamePattern);

            sql::ResultSet* getTables(const sql::SQLString& catalog, const sql::SQLString& schemaPattern, const sql::SQLString& tableNamePattern, std::list<sql::SQLString> &types);

            sql::ResultSet* getTableTypes();

            const sql::SQLString& getTimeDateFunctions();

            sql::ResultSet* getTypeInfo();

            sql::ResultSet* getUDTs(const sql::SQLString& catalog, const sql::SQLString& schemaPattern, const sql::SQLString& typeNamePattern, std::list<int> &types);

            SQLString getURL();

            SQLString getUserName();

            sql::ResultSet* getVersionColumns(const sql::SQLString& catalog, const sql::SQLString& schema, const sql::SQLString& table);

            bool insertsAreDetected(int type);

            bool isCatalogAtStart();

            bool isReadOnly();

            bool locatorsUpdateCopy();

            bool nullPlusNonNullIsNull();

            bool nullsAreSortedAtEnd();

            bool nullsAreSortedAtStart();

            bool nullsAreSortedHigh();

            bool nullsAreSortedLow();

            bool othersDeletesAreVisible(int type);

            bool othersInsertsAreVisible(int type);

            bool othersUpdatesAreVisible(int type);

            bool ownDeletesAreVisible(int type);

            bool ownInsertsAreVisible(int type);

            bool ownUpdatesAreVisible(int type);

            bool storesLowerCaseIdentifiers();

            bool storesLowerCaseQuotedIdentifiers();

            bool storesMixedCaseIdentifiers();

            bool storesMixedCaseQuotedIdentifiers();

            bool storesUpperCaseIdentifiers();

            bool storesUpperCaseQuotedIdentifiers();

            bool supportsAlterTableWithAddColumn();

            bool supportsAlterTableWithDropColumn();

            bool supportsANSI92EntryLevelSQL();

            bool supportsANSI92FullSQL();

            bool supportsANSI92IntermediateSQL();

            bool supportsBatchUpdates();

            bool supportsCatalogsInDataManipulation();

            bool supportsCatalogsInIndexDefinitions();

            bool supportsCatalogsInPrivilegeDefinitions();

            bool supportsCatalogsInProcedureCalls();

            bool supportsCatalogsInTableDefinitions();

            bool supportsColumnAliasing();

            bool supportsConvert();

            bool supportsConvert(int fromType, int toType);

            bool supportsCoreSQLGrammar();

            bool supportsCorrelatedSubqueries();

            bool supportsDataDefinitionAndDataManipulationTransactions();

            bool supportsDataManipulationTransactionsOnly();

            bool supportsDifferentTableCorrelationNames();

            bool supportsExpressionsInOrderBy();

            bool supportsExtendedSQLGrammar();

            bool supportsFullOuterJoins();

            bool supportsGetGeneratedKeys();

            bool supportsGroupBy();

            bool supportsGroupByBeyondSelect();

            bool supportsGroupByUnrelated();

            bool supportsIntegrityEnhancementFacility();

            bool supportsLikeEscapeClause();

            bool supportsLimitedOuterJoins();

            bool supportsMinimumSQLGrammar();

            bool supportsMixedCaseIdentifiers();

            bool supportsMixedCaseQuotedIdentifiers();

            bool supportsMultipleOpenResults();

            bool supportsMultipleResultSets();

            bool supportsMultipleTransactions();

            bool supportsNamedParameters();

            bool supportsNonNullableColumns();

            bool supportsOpenCursorsAcrossCommit();

            bool supportsOpenCursorsAcrossRollback();

            bool supportsOpenStatementsAcrossCommit();

            bool supportsOpenStatementsAcrossRollback();

            bool supportsOrderByUnrelated();

            bool supportsOuterJoins();

            bool supportsPositionedDelete();

            bool supportsPositionedUpdate();

            bool supportsResultSetConcurrency(int type, int concurrency);

            bool supportsResultSetHoldability(int holdability);

            bool supportsResultSetType(int type);

            bool supportsSavepoints();

            bool supportsSchemasInDataManipulation();

            bool supportsSchemasInIndexDefinitions();

            bool supportsSchemasInPrivilegeDefinitions();

            bool supportsSchemasInProcedureCalls();

            bool supportsSchemasInTableDefinitions();

            bool supportsSelectForUpdate();

            bool supportsStatementPooling();

            bool supportsStoredProcedures();

            bool supportsSubqueriesInComparisons();

            bool supportsSubqueriesInExists();

            bool supportsSubqueriesInIns();

            bool supportsSubqueriesInQuantifieds();

            bool supportsTableCorrelationNames();

            bool supportsTransactionIsolationLevel(int level);

            bool supportsTransactions();

            bool supportsTypeConversion();

            bool supportsUnion();

            bool supportsUnionAll();

            bool updatesAreDetected(int type);

            bool usesLocalFilePerTable();

            bool usesLocalFiles();

            sql::ResultSet* getSchemata(const sql::SQLString& catalogName = "");

            sql::ResultSet* getSchemaObjects(const sql::SQLString& catalogName = "", const sql::SQLString& schemaName = "", const sql::SQLString& objectType = "", bool includingDdl = true, const sql::SQLString& objectName = "", const sql::SQLString& contextTableName = "");

            // Returns all schema object types this database supports
            sql::ResultSet* getSchemaObjectTypes();

        private:
            bool matchTable(const sql::SQLString& sPattern, const sql::SQLString& tPattern, const sql::SQLString& schema, const sql::SQLString& table);
            bool parseImportedKeys(
                const sql::SQLString& def,
                sql::SQLString& constraint_name,
                std::map< sql::SQLString, sql::SQLString > & keywords_names,
                std::map< sql::SQLString, std::list< sql::SQLString > > & referenced_fields,
                std::map< sql::SQLString, int > & update_delete_action
            );

            /* Prevent use of these */
            MySQL_ConnectionMetaData();
            MySQL_ConnectionMetaData(const MySQL_ConnectionMetaData&);
            void operator=(MySQL_ConnectionMetaData&);
        };

    } /* namespace mysql */
} /* namespace sql */
#endif // _MYSQL_METADATA_H_

/*
 * Local variables:
 * tab-width: 4
 * c-basic-offset: 4
 * End:
 * vim600: noet sw=4 ts=4 fdm=marker
 * vim<600: noet sw=4 ts=4
 */