You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
446 lines
16 KiB
446 lines
16 KiB
5 months ago
|
/* Copyright (c) 2014, 2018, Oracle and/or its affiliates. All rights reserved.
|
||
|
|
|
||
|
|
This program is free software; you can redistribute it and/or modify
|
||
|
|
it under the terms of the GNU General Public License, version 2.0,
|
||
|
|
as published by the Free Software Foundation.
|
||
|
|
|
||
|
|
This program is also distributed with certain software (including
|
||
|
|
but not limited to OpenSSL) that is licensed under separate terms,
|
||
|
|
as designated in a particular file or component or in included license
|
||
|
|
documentation. The authors of MySQL hereby grant you an additional
|
||
|
|
permission to link the program and your derivative works with the
|
||
|
|
separately licensed software that they have included with MySQL.
|
||
|
|
|
||
|
|
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, version 2.0, 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 DD__DICTIONARY_INCLUDED
|
||
|
|
#define DD__DICTIONARY_INCLUDED
|
||
|
|
|
||
|
|
#include "my_compiler.h"
|
||
|
|
#include "sql/dd/string_type.h" // dd::String_type
|
||
|
|
#include "sql/dd/types/tablespace.h"
|
||
|
|
|
||
|
|
class THD;
|
||
|
|
class MDL_ticket;
|
||
|
|
class Plugin_table;
|
||
|
|
// class Tablespace;
|
||
|
|
|
||
|
|
namespace dd {
|
||
|
|
|
||
|
|
///////////////////////////////////////////////////////////////////////////
|
||
|
|
|
||
|
|
class Collation;
|
||
|
|
class Object_table;
|
||
|
|
class Schema;
|
||
|
|
class Tablespace;
|
||
|
|
|
||
|
|
namespace cache {
|
||
|
|
class Dictionary_client;
|
||
|
|
}
|
||
|
|
|
||
|
|
///////////////////////////////////////////////////////////////////////////
|
||
|
|
|
||
|
|
/// Main interface class enabling users to operate on data dictionary.
|
||
|
|
class Dictionary {
|
||
|
|
public:
|
||
|
|
/**
|
||
|
|
Get dictionary object for a given dictionary table name.
|
||
|
|
If the given schema_name and table_name is not a dictionary
|
||
|
|
table name, then the function returns NULL.
|
||
|
|
|
||
|
|
@returns Pointer to dictionary object for the given
|
||
|
|
dictionary table name, else NULL.
|
||
|
|
*/
|
||
|
|
virtual const Object_table *get_dd_table(
|
||
|
|
const String_type &schema_name, const String_type &table_name) const = 0;
|
||
|
|
|
||
|
|
public:
|
||
|
|
/////////////////////////////////////////////////////////////////////////
|
||
|
|
// Auxiliary operations.
|
||
|
|
/////////////////////////////////////////////////////////////////////////
|
||
|
|
|
||
|
|
/**
|
||
|
|
Check if the given schema name is 'mysql', which where
|
||
|
|
the DD tables are stored.
|
||
|
|
|
||
|
|
@param schema_name Schema name to check.
|
||
|
|
|
||
|
|
@returns true - If schema_name is 'mysql'
|
||
|
|
@returns false - If schema_name is not 'mysql'
|
||
|
|
*/
|
||
|
|
virtual bool is_dd_schema_name(const String_type &schema_name) const = 0;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Check if given table name is a dictionary table name.
|
||
|
|
|
||
|
|
@param schema_name Schema name to check.
|
||
|
|
@param table_name Table name to check.
|
||
|
|
|
||
|
|
@returns true - If given table name is a dictionary table.
|
||
|
|
@returns false - If table name is not a dictionary table.
|
||
|
|
*/
|
||
|
|
virtual bool is_dd_table_name(const String_type &schema_name,
|
||
|
|
const String_type &table_name) const = 0;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Check if given table name is a system table name.
|
||
|
|
|
||
|
|
@param schema_name Schema name to check.
|
||
|
|
@param table_name Table name to check.
|
||
|
|
|
||
|
|
@returns true - If given table name is a system table.
|
||
|
|
@returns false - If table name is not a system table.
|
||
|
|
*/
|
||
|
|
virtual bool is_system_table_name(const String_type &schema_name,
|
||
|
|
const String_type &table_name) const = 0;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Get the error code representing the type name string for a dictionary
|
||
|
|
or system table.
|
||
|
|
|
||
|
|
Necessary to support localization of error messages.
|
||
|
|
|
||
|
|
@param schema_name Schema name to check.
|
||
|
|
@param table_name Table name to check.
|
||
|
|
|
||
|
|
@returns The error code representing the type name associated with the
|
||
|
|
table, for being used in error messages.
|
||
|
|
*/
|
||
|
|
virtual int table_type_error_code(const String_type &schema_name,
|
||
|
|
const String_type &table_name) const = 0;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Check if given table name can be accessed by the given thread type.
|
||
|
|
|
||
|
|
@param is_dd_internal_thread 'true' if this is a DD internal
|
||
|
|
thread.
|
||
|
|
@param is_ddl_statement 'true' if this is a DDL statement.
|
||
|
|
@param schema_name Schema name to check.
|
||
|
|
@param schema_length Length of schema name to check.
|
||
|
|
@param table_name Table name to check.
|
||
|
|
|
||
|
|
@returns true - If given table name is accessible by the thread type.
|
||
|
|
@returns false - If table name is not accessible.
|
||
|
|
*/
|
||
|
|
virtual bool is_dd_table_access_allowed(bool is_dd_internal_thread,
|
||
|
|
bool is_ddl_statement,
|
||
|
|
const char *schema_name,
|
||
|
|
size_t schema_length,
|
||
|
|
const char *table_name) const = 0;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Check if given table name is a system view name.
|
||
|
|
|
||
|
|
@param schema_name Schema name to check.
|
||
|
|
@param table_name Table name to check.
|
||
|
|
@param[out] hidden Pointer to boolean flag indicating
|
||
|
|
if the object is hidden.
|
||
|
|
|
||
|
|
@returns true - If given table name is a system view.
|
||
|
|
@returns false - If table name is not a system view.
|
||
|
|
*/
|
||
|
|
virtual bool is_system_view_name(const char *schema_name,
|
||
|
|
const char *table_name,
|
||
|
|
bool *hidden) const = 0;
|
||
|
|
|
||
|
|
/**
|
||
|
|
Check if given table name is a system view name.
|
||
|
|
|
||
|
|
@param schema_name Schema name to check.
|
||
|
|
@param table_name Table name to check.
|
||
|
|
|
||
|
|
@returns true - If given table name is a system view.
|
||
|
|
@returns false - If table name is not a system view.
|
||
|
|
*/
|
||
|
|
virtual bool is_system_view_name(const char *schema_name,
|
||
|
|
const char *table_name) const = 0;
|
||
|
|
|
||
|
|
public:
|
||
|
|
// Destructor to cleanup data dictionary instance upon server shutdown.
|
||
|
|
virtual ~Dictionary() {}
|
||
|
|
};
|
||
|
|
|
||
|
|
///////////////////////////////////////////////////////////////////////////
|
||
|
|
|
||
|
|
//
|
||
|
|
// MDL wrapper functions
|
||
|
|
//
|
||
|
|
|
||
|
|
/**
|
||
|
|
@brief
|
||
|
|
Acquire shared metadata lock on the given table name with
|
||
|
|
explicit duration.
|
||
|
|
|
||
|
|
@param thd - THD to which lock belongs to.
|
||
|
|
@param schema_name - Schema name
|
||
|
|
@param table_name - Table name
|
||
|
|
@param no_wait - Use try_acquire_lock() if no_wait is true.
|
||
|
|
else use acquire_lock() with
|
||
|
|
thd->variables.lock_wait_timeout timeout value.
|
||
|
|
@param out_mdl_ticket - This is a OUT parameter, a pointer to MDL_ticket
|
||
|
|
upon successful lock attempt.
|
||
|
|
|
||
|
|
*/
|
||
|
|
bool acquire_shared_table_mdl(THD *thd, const char *schema_name,
|
||
|
|
const char *table_name, bool no_wait,
|
||
|
|
MDL_ticket **out_mdl_ticket)
|
||
|
|
MY_ATTRIBUTE((warn_unused_result));
|
||
|
|
|
||
|
|
/**
|
||
|
|
Predicate to check if we have a shared meta data lock on the
|
||
|
|
submitted schema qualified table name.
|
||
|
|
|
||
|
|
@param thd Thread context.
|
||
|
|
@param schema_name Schema name.
|
||
|
|
@param table_name Table name.
|
||
|
|
|
||
|
|
@retval true The thread context has a lock.
|
||
|
|
@retval false The thread context does not have a lock.
|
||
|
|
*/
|
||
|
|
|
||
|
|
bool has_shared_table_mdl(THD *thd, const char *schema_name,
|
||
|
|
const char *table_name);
|
||
|
|
|
||
|
|
/**
|
||
|
|
Predicate to check if we have an exclusive meta data lock on the
|
||
|
|
submitted schema qualified table name.
|
||
|
|
|
||
|
|
@param thd Thread context.
|
||
|
|
@param schema_name Schema name.
|
||
|
|
@param table_name Table name.
|
||
|
|
|
||
|
|
@retval true The thread context has a lock.
|
||
|
|
@retval false The thread context does not have a lock.
|
||
|
|
*/
|
||
|
|
|
||
|
|
bool has_exclusive_table_mdl(THD *thd, const char *schema_name,
|
||
|
|
const char *table_name);
|
||
|
|
|
||
|
|
/**
|
||
|
|
Acquire an exclusive metadata lock on the given tablespace name with
|
||
|
|
transaction duration.
|
||
|
|
|
||
|
|
@param thd THD to which lock belongs.
|
||
|
|
@param tablespace_name Tablespace name
|
||
|
|
@param no_wait Use try_acquire_lock() if no_wait is true,
|
||
|
|
else use acquire_lock() with
|
||
|
|
thd->variables.lock_wait_timeout timeout value.
|
||
|
|
@param ticket ticket for request (optional out parameter)
|
||
|
|
@param for_trx true if MDL duration is MDL_TRANSACTION
|
||
|
|
false if MDL duration is MDL_EXPLICIT
|
||
|
|
|
||
|
|
@retval true Failure, e.g. a lock wait timeout.
|
||
|
|
@retval false Successful lock acquisition.
|
||
|
|
*/
|
||
|
|
|
||
|
|
bool acquire_exclusive_tablespace_mdl(THD *thd, const char *tablespace_name,
|
||
|
|
bool no_wait,
|
||
|
|
MDL_ticket **ticket = nullptr,
|
||
|
|
bool for_trx = true)
|
||
|
|
MY_ATTRIBUTE((warn_unused_result));
|
||
|
|
|
||
|
|
/**
|
||
|
|
Acquire a shared metadata lock on the given tablespace name with
|
||
|
|
transaction duration.
|
||
|
|
|
||
|
|
@param thd THD to which lock belongs.
|
||
|
|
@param tablespace_name Tablespace name
|
||
|
|
@param no_wait Use try_acquire_lock() if no_wait is true,
|
||
|
|
else use acquire_lock() with
|
||
|
|
thd->variables.lock_wait_timeout timeout value.
|
||
|
|
@param ticket ticket for request (optional out parameter)
|
||
|
|
@param for_trx true if MDL duration is MDL_TRANSACTION
|
||
|
|
false if MDL duration is MDL_EXPLICIT
|
||
|
|
|
||
|
|
@retval true Failure, e.g. a lock wait timeout.
|
||
|
|
@retval false Successful lock acquisition.
|
||
|
|
*/
|
||
|
|
bool acquire_shared_tablespace_mdl(THD *thd, const char *tablespace_name,
|
||
|
|
bool no_wait, MDL_ticket **ticket = nullptr,
|
||
|
|
bool for_trx = true)
|
||
|
|
MY_ATTRIBUTE((warn_unused_result));
|
||
|
|
|
||
|
|
/**
|
||
|
|
Predicate to check if we have a shared meta data lock on the
|
||
|
|
submitted tablespace name.
|
||
|
|
|
||
|
|
@param thd Thread context.
|
||
|
|
@param tablespace_name Tablespace name.
|
||
|
|
|
||
|
|
@retval true The thread context has a lock.
|
||
|
|
@retval false The thread context does not have a lock.
|
||
|
|
*/
|
||
|
|
|
||
|
|
bool has_shared_tablespace_mdl(THD *thd, const char *tablespace_name);
|
||
|
|
|
||
|
|
/**
|
||
|
|
Predicate to check if we have an exclusive meta data lock on the
|
||
|
|
submitted tablespace name.
|
||
|
|
|
||
|
|
@param thd Thread context.
|
||
|
|
@param tablespace_name Tablespace name.
|
||
|
|
|
||
|
|
@retval true The thread context has a lock.
|
||
|
|
@retval false The thread context does not have a lock.
|
||
|
|
*/
|
||
|
|
|
||
|
|
bool has_exclusive_tablespace_mdl(THD *thd, const char *tablespace_name);
|
||
|
|
|
||
|
|
/**
|
||
|
|
Acquire exclusive metadata lock on the given table name with
|
||
|
|
TRANSACTIONAL duration.
|
||
|
|
|
||
|
|
@param[in] thd THD to which lock belongs to.
|
||
|
|
@param[in] schema_name Schema name
|
||
|
|
@param[in] table_name Table name
|
||
|
|
@param[in] no_wait Use try_acquire_lock() if no_wait is true.
|
||
|
|
else use acquire_lock() with
|
||
|
|
thd->variables.lock_wait_timeout timeout value.
|
||
|
|
@param[out] out_mdl_ticket A pointer to MDL_ticket upon successful lock
|
||
|
|
attempt.
|
||
|
|
*/
|
||
|
|
|
||
|
|
bool acquire_exclusive_table_mdl(THD *thd, const char *schema_name,
|
||
|
|
const char *table_name, bool no_wait,
|
||
|
|
MDL_ticket **out_mdl_ticket)
|
||
|
|
MY_ATTRIBUTE((warn_unused_result));
|
||
|
|
|
||
|
|
/**
|
||
|
|
Acquire exclusive metadata lock on the given table name with
|
||
|
|
TRANSACTIONAL duration.
|
||
|
|
|
||
|
|
@param[in] thd THD to which lock belongs to.
|
||
|
|
@param[in] schema_name Schema name
|
||
|
|
@param[in] table_name Table name
|
||
|
|
@param[in] lock_wait_timeout Time to wait.
|
||
|
|
@param[out] out_mdl_ticket A pointer to MDL_ticket upon successful lock
|
||
|
|
attempt.
|
||
|
|
*/
|
||
|
|
|
||
|
|
bool acquire_exclusive_table_mdl(THD *thd, const char *schema_name,
|
||
|
|
const char *table_name,
|
||
|
|
unsigned long int lock_wait_timeout,
|
||
|
|
MDL_ticket **out_mdl_ticket)
|
||
|
|
MY_ATTRIBUTE((warn_unused_result));
|
||
|
|
|
||
|
|
/**
|
||
|
|
Acquire exclusive metadata lock on the given schema name with
|
||
|
|
explicit duration.
|
||
|
|
|
||
|
|
@param[in] thd THD to which lock belongs to.
|
||
|
|
@param[in] schema_name Schema name
|
||
|
|
@param[in] no_wait Use try_acquire_lock() if no_wait is true.
|
||
|
|
else use acquire_lock() with
|
||
|
|
thd->variables.lock_wait_timeout timeout value.
|
||
|
|
@param[out] out_mdl_ticket A pointer to MDL_ticket upon successful lock
|
||
|
|
attempt.
|
||
|
|
*/
|
||
|
|
|
||
|
|
bool acquire_exclusive_schema_mdl(THD *thd, const char *schema_name,
|
||
|
|
bool no_wait, MDL_ticket **out_mdl_ticket)
|
||
|
|
MY_ATTRIBUTE((warn_unused_result));
|
||
|
|
|
||
|
|
/**
|
||
|
|
@brief
|
||
|
|
Release MDL_EXPLICIT lock held by a ticket
|
||
|
|
|
||
|
|
@param thd - THD to which lock belongs to.
|
||
|
|
@param mdl_ticket - Lock ticket.
|
||
|
|
|
||
|
|
*/
|
||
|
|
void release_mdl(THD *thd, MDL_ticket *mdl_ticket);
|
||
|
|
|
||
|
|
/** Get Dictionary_client from THD object (the latter is opaque * in SEs). */
|
||
|
|
cache::Dictionary_client *get_dd_client(THD *thd);
|
||
|
|
|
||
|
|
/**
|
||
|
|
Create plugin native table. The API would only write metadata to DD
|
||
|
|
and skip calling handler::create().
|
||
|
|
|
||
|
|
@param[in] thd THD to which lock belongs to.
|
||
|
|
@param[in] pt Plugin_table* contain metadata of table to
|
||
|
|
be created.
|
||
|
|
|
||
|
|
@returns false on success, otherwise true.
|
||
|
|
*/
|
||
|
|
|
||
|
|
bool create_native_table(THD *thd, const Plugin_table *pt);
|
||
|
|
|
||
|
|
/**
|
||
|
|
Remove plugin native table from DD. The API would only update
|
||
|
|
metadata to DD and skip calling handler::drop().
|
||
|
|
|
||
|
|
@param[in] thd THD to which lock belongs to.
|
||
|
|
@param[in] schema_name schema name which the table belongs to.
|
||
|
|
@param[in] table_name table name to be dropped.
|
||
|
|
|
||
|
|
@returns false on success, otherwise true.
|
||
|
|
*/
|
||
|
|
|
||
|
|
bool drop_native_table(THD *thd, const char *schema_name,
|
||
|
|
const char *table_name);
|
||
|
|
|
||
|
|
/**
|
||
|
|
Reset the tables and tablespace partitions in the DD cache,
|
||
|
|
and invalidate the entries in the DDSE cache.
|
||
|
|
|
||
|
|
@note This is a temporary workaround to support proper recovery
|
||
|
|
after ha_recover().
|
||
|
|
|
||
|
|
@returns false on success, otherwise true.
|
||
|
|
*/
|
||
|
|
bool reset_tables_and_tablespaces();
|
||
|
|
|
||
|
|
/**
|
||
|
|
Update a tablespace change, commit and release transactional MDL.
|
||
|
|
|
||
|
|
@param[in,out] thd Current thread context.
|
||
|
|
@param[in,out] space Tablespace to update and commit.
|
||
|
|
@param[in] error true for failure: Do rollback.
|
||
|
|
false for success: Do commit.
|
||
|
|
@param[in] release_mdl_on_commit_only release MDLs only on commit
|
||
|
|
|
||
|
|
@retval true If error is true, or if failure in update or in commit.
|
||
|
|
@retval false Otherwise.
|
||
|
|
*/
|
||
|
|
|
||
|
|
bool commit_or_rollback_tablespace_change(
|
||
|
|
THD *thd, dd::Tablespace *space, bool error,
|
||
|
|
bool release_mdl_on_commit_only = false);
|
||
|
|
|
||
|
|
/**
|
||
|
|
Get the Object_table instance storing the given entity object type.
|
||
|
|
|
||
|
|
We can return this as a reference since all relevant types for which
|
||
|
|
this template is used will indeed have a corresponding object table.
|
||
|
|
|
||
|
|
@tparam Entity_object_type Type for which to get the object table.
|
||
|
|
|
||
|
|
@returns reference to Object_table instance.
|
||
|
|
*/
|
||
|
|
template <typename Entity_object_type>
|
||
|
|
const Object_table &get_dd_table();
|
||
|
|
|
||
|
|
/**
|
||
|
|
Implicit tablespaces are renamed inside SE. But it is necessary to inform the
|
||
|
|
server layer about the rename, specifically which MDLs have been taken, so
|
||
|
|
that it can perform the necessary adjustment of MDLs when running in LOCK
|
||
|
|
TABLES mode.
|
||
|
|
|
||
|
|
@param thd thread context
|
||
|
|
@param src ticket for old name
|
||
|
|
@param dst ticket for new name
|
||
|
|
*/
|
||
|
|
void rename_tablespace_mdl_hook(THD *thd, MDL_ticket *src, MDL_ticket *dst);
|
||
|
|
|
||
|
|
} // namespace dd
|
||
|
|
|
||
|
|
#endif // DD__DICTIONARY_INCLUDED
|