polardbxengine/sql/dd/impl/tables/foreign_keys.h

105 lines
3.6 KiB
C++

/* Copyright (c) 2014, 2019, 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_TABLES__FOREIGN_KEYS_INCLUDED
#define DD_TABLES__FOREIGN_KEYS_INCLUDED
#include "sql/dd/impl/types/object_table_impl.h" // dd::Object_table_impl
#include "sql/dd/object_id.h" // dd::Object_id
#include "sql/dd/string_type.h"
namespace dd {
class Object_key;
namespace tables {
///////////////////////////////////////////////////////////////////////////
class Foreign_keys : public Object_table_impl {
public:
static const Foreign_keys &instance();
static const CHARSET_INFO *name_collation();
enum enum_fields {
FIELD_ID,
FIELD_SCHEMA_ID,
FIELD_TABLE_ID,
FIELD_NAME,
FIELD_UNIQUE_CONSTRAINT_NAME,
FIELD_MATCH_OPTION,
FIELD_UPDATE_RULE,
FIELD_DELETE_RULE,
FIELD_REFERENCED_TABLE_CATALOG,
FIELD_REFERENCED_TABLE_SCHEMA,
FIELD_REFERENCED_TABLE,
FIELD_OPTIONS,
NUMBER_OF_FIELDS // Always keep this entry at the end of the enum
};
enum enum_indexes {
INDEX_PK_ID = static_cast<uint>(Common_index::PK_ID),
INDEX_UK_SCHEMA_ID_NAME = static_cast<uint>(Common_index::UK_NAME),
INDEX_UK_TABLE_ID_NAME,
INDEX_K_REF_CATALOG_REF_SCHEMA_REF_TABLE
};
enum enum_foreign_keys { FK_SCHEMA_ID };
Foreign_keys();
static Object_key *create_key_by_foreign_key_name(
Object_id schema_id, const String_type &foreign_key_name);
static Object_key *create_key_by_table_id(Object_id table_id);
static Object_key *create_key_by_referenced_name(
const String_type &referenced_catalog,
const String_type &referenced_schema,
const String_type &referenced_table);
/**
Check if schema contains foreign key with specified name.
@param thd Thread context.
@param schema_id Id of schema to be inspected.
@param foreign_key_name Name of the foreign key.
@param [out] exists Set to true if foreign key with
the name provided exists in the
schema, false otherwise.
@retval false No error.
@retval true Error.
*/
static bool check_foreign_key_exists(THD *thd, Object_id schema_id,
const String_type &foreign_key_name,
bool *exists);
};
///////////////////////////////////////////////////////////////////////////
} // namespace tables
} // namespace dd
#endif // DD_TABLES__FOREIGN_KEYS_INCLUDED