Update doc. [#CLICKHOUSE-5]

This commit is contained in:
Vitaliy Lyudvichenko 2017-05-16 22:03:52 +03:00
parent d472065af0
commit 226d84be09
4 changed files with 59 additions and 22 deletions

View File

@ -24,9 +24,6 @@ public:
private: private:
ASTPtr query_ptr; ASTPtr query_ptr;
Context & context; Context & context;
BlockIO executeOnServer(ASTDropQuery & drop);
BlockIO executeOnCluster(ASTDropQuery & drop);
}; };

View File

@ -1,3 +1,5 @@
.. _configuration_files:
Configuration files Configuration files
====================== ======================

View File

@ -13,8 +13,10 @@ If "IF NOT EXISTS" is included, the query won't return an error if the database
CREATE TABLE CREATE TABLE
~~~~~~~~~~~~ ~~~~~~~~~~~~
The ``CREATE TABLE`` query can have several forms. The ``CREATE TABLE`` query can have several forms.
::
CREATE [TEMPORARY] TABLE [IF NOT EXISTS] [db.]name .. code-block:: sql
CREATE [TEMPORARY] TABLE [IF NOT EXISTS] [db.]name [ON CLUSTER cluster]
( (
name1 [type1] [DEFAULT|MATERIALIZED|ALIAS expr1], name1 [type1] [DEFAULT|MATERIALIZED|ALIAS expr1],
name2 [type2] [DEFAULT|MATERIALIZED|ALIAS expr2], name2 [type2] [DEFAULT|MATERIALIZED|ALIAS expr2],
@ -37,7 +39,7 @@ Creates a table with a structure like the result of the ``SELECT`` query, with t
In all cases, if IF NOT EXISTS is specified, the query won't return an error if the table already exists. In this case, the query won't do anything. In all cases, if IF NOT EXISTS is specified, the query won't return an error if the table already exists. In this case, the query won't do anything.
Default values Default values
""""""""""""""""""""" """"""""""""""
The column description can specify an expression for a default value, in one of the following ways: The column description can specify an expression for a default value, in one of the following ways:
``DEFAULT expr``, ``MATERIALIZED expr``, ``ALIAS expr``. ``DEFAULT expr``, ``MATERIALIZED expr``, ``ALIAS expr``.
Example: ``URLDomain String DEFAULT domain(URL)``. Example: ``URLDomain String DEFAULT domain(URL)``.
@ -73,7 +75,7 @@ If you add a new column to a table but later change its default expression, the
It is not possible to set default values for elements in nested data structures. It is not possible to set default values for elements in nested data structures.
Temporary tables Temporary tables
""""""""""""""""" """"""""""""""""
In all cases, if TEMPORARY is specified, a temporary table will be created. Temporary tables have the following characteristics: In all cases, if TEMPORARY is specified, a temporary table will be created. Temporary tables have the following characteristics:
- Temporary tables disappear when the session ends, including if the connection is lost. - Temporary tables disappear when the session ends, including if the connection is lost.
- A temporary table is created with the Memory engine. The other table engines are not supported. - A temporary table is created with the Memory engine. The other table engines are not supported.
@ -83,6 +85,20 @@ In all cases, if TEMPORARY is specified, a temporary table will be created. Temp
In most cases, temporary tables are not created manually, but when using external data for a query, or for distributed (GLOBAL) IN. For more information, see the appropriate sections. In most cases, temporary tables are not created manually, but when using external data for a query, or for distributed (GLOBAL) IN. For more information, see the appropriate sections.
Distributed DDL queries (section ``ON CLUSTER``)
""""""""""""""""""""""""""""""""""""""""""""""""
Queries ``CREATE``, ``DROP``, ``ALTER``, ``RENAME`` support distributed execution on cluster.
For example, the following query creates ``Distributed`` table ``all_hits`` for each host of the cluster ``cluster``:
.. code-block:: sql
CREATE TABLE IF NOT EXISTS all_hits ON CLUSTER cluster (p Date, i Int32) ENGINE = Distributed(cluster, default, hits)
To correctly execute such queries you need to have equal definitions of the cluster on each host (you can use :ref:`ZooKeeper substitutions <configuration_files>` to syncronize configs on hosts) and connection to ZooKeeper quorum.
Local version of the query will be eventually executed on each host of the cluster, even if some hosts are temporary unavaiable; on each host queries are executed stictly sequentually.
At the moment, ``ALTER`` queries for replicated tables are not supported yet.
CREATE VIEW CREATE VIEW
~~~~~~~~~~~~ ~~~~~~~~~~~~
``CREATE [MATERIALIZED] VIEW [IF NOT EXISTS] [db.]name [ENGINE = engine] [POPULATE] AS SELECT ...`` ``CREATE [MATERIALIZED] VIEW [IF NOT EXISTS] [db.]name [ENGINE = engine] [POPULATE] AS SELECT ...``
@ -130,13 +146,17 @@ This query is used when starting the server. The server stores table metadata as
DROP DROP
~~~~ ~~~~
This query has two types: ``DROP DATABASE`` and ``DROP TABLE``. This query has two types: ``DROP DATABASE`` and ``DROP TABLE``.
::
DROP DATABASE [IF EXISTS] db .. code-block:: sql
DROP DATABASE [IF EXISTS] db [ON CLUSTER cluster]
Deletes all tables inside the 'db' database, then deletes the 'db' database itself. Deletes all tables inside the 'db' database, then deletes the 'db' database itself.
If IF EXISTS is specified, it doesn't return an error if the database doesn't exist. If IF EXISTS is specified, it doesn't return an error if the database doesn't exist.
::
DROP TABLE [IF EXISTS] [db.]name .. code-block:: sql
DROP TABLE [IF EXISTS] [db.]name [ON CLUSTER cluster]
Deletes the table. Deletes the table.
If IF EXISTS is specified, it doesn't return an error if the table doesn't exist or the database doesn't exist. If IF EXISTS is specified, it doesn't return an error if the table doesn't exist or the database doesn't exist.
@ -154,8 +174,10 @@ There is no DETACH DATABASE query.
RENAME RENAME
~~~~~~ ~~~~~~
Renames one or more tables. Renames one or more tables.
::
RENAME TABLE [db11.]name11 TO [db12.]name12, [db21.]name21 TO [db22.]name22, ... .. code-block:: sql
RENAME TABLE [db11.]name11 TO [db12.]name12, [db21.]name21 TO [db22.]name22, ... [ON CLUSTER cluster]
All tables are renamed under global locking. Renaming tables is a light operation. If you indicated another database after TO, the table will be moved to this database. However, the directories with databases must reside in the same file system (otherwise, an error is returned). All tables are renamed under global locking. Renaming tables is a light operation. If you indicated another database after TO, the table will be moved to this database. However, the directories with databases must reside in the same file system (otherwise, an error is returned).
@ -166,8 +188,10 @@ The ALTER query is only supported for *MergeTree type tables, as well as for Mer
Column manipulations Column manipulations
"""""""""""""""""""""""" """"""""""""""""""""""""
Lets you change the table structure. Lets you change the table structure.
::
ALTER TABLE [db].name ADD|DROP|MODIFY COLUMN ... .. code-block:: sql
ALTER TABLE [db].name [ON CLUSTER cluster] ADD|DROP|MODIFY COLUMN ...
In the query, specify a list of one or more comma-separated actions. Each action is an operation on a column. In the query, specify a list of one or more comma-separated actions. Each action is an operation on a column.

View File

@ -18,7 +18,7 @@ CREATE TABLE
.. code-block:: sql .. code-block:: sql
CREATE [TEMPORARY] TABLE [IF NOT EXISTS] [db.]name CREATE [TEMPORARY] TABLE [IF NOT EXISTS] [db.]name [ON CLUSTER cluster]
( (
name1 [type1] [DEFAULT|MATERIALIZED|ALIAS expr1], name1 [type1] [DEFAULT|MATERIALIZED|ALIAS expr1],
name2 [type2] [DEFAULT|MATERIALIZED|ALIAS expr2], name2 [type2] [DEFAULT|MATERIALIZED|ALIAS expr2],
@ -92,6 +92,20 @@ CREATE TABLE
В большинстве случаев, временные таблицы создаются не вручную, а при использовании внешних данных для запроса, или при распределённом ``(GLOBAL) IN``. Подробнее см. соответствующие разделы В большинстве случаев, временные таблицы создаются не вручную, а при использовании внешних данных для запроса, или при распределённом ``(GLOBAL) IN``. Подробнее см. соответствующие разделы
Распределенные DDL запросы (секция ``ON CLUSTER``)
""""""""""""""""""""""""""""""""""""""""""""""""""
Запросы ``CREATE``, ``DROP``, ``ALTER``, ``RENAME`` поддерживают возможность распределенного выполнения на кластере.
Например, следующий запрос создает ``Distributed``-таблицу ``all_hits`` на каждом хосте кластера ``cluster``:
.. code-block:: sql
CREATE TABLE IF NOT EXISTS all_hits ON CLUSTER cluster (p Date, i Int32) ENGINE = Distributed(cluster, default, hits)
Для корректного выполнения таких запросов необходимо на каждом хосте иметь одинаковое определение кластера (для упрощения синхронизации конфигов можете использовать :ref:`подстановки из ZooKeeper <configurattion_files>`), также необходимо подключение к ZooKeeper серверам.
Локальная версия запроса в конечном итоге будет выполнена на каждом хосте кластера, даже если некоторые хосты в данный момент не доступны, гарантируется упорядоченность выполнения запросов в рамках одного хоста.
Пока не поддерживаются ``ALTER``-запросы для реплицированных таблиц.
CREATE VIEW CREATE VIEW
~~~~~~~~~~~~ ~~~~~~~~~~~~
@ -152,14 +166,14 @@ DROP
.. code-block:: sql .. code-block:: sql
DROP DATABASE [IF EXISTS] db DROP DATABASE [IF EXISTS] db [ON CLUSTER cluster]
Удаляет все таблицы внутри базы данных db, а затем саму базу данных db. Удаляет все таблицы внутри базы данных db, а затем саму базу данных db.
Если указано ``IF EXISTS`` - не выдавать ошибку, если база данных не существует. Если указано ``IF EXISTS`` - не выдавать ошибку, если база данных не существует.
.. code-block:: sql .. code-block:: sql
DROP TABLE [IF EXISTS] [db.]name DROP TABLE [IF EXISTS] [db.]name [ON CLUSTER cluster]
Удаляет таблицу. Удаляет таблицу.
Если указано ``IF EXISTS`` - не выдавать ошибку, если таблица не существует или база данных не существует. Если указано ``IF EXISTS`` - не выдавать ошибку, если таблица не существует или база данных не существует.
@ -183,7 +197,7 @@ RENAME
.. code-block:: sql .. code-block:: sql
RENAME TABLE [db11.]name11 TO [db12.]name12, [db21.]name21 TO [db22.]name22, ... RENAME TABLE [db11.]name11 TO [db12.]name12, [db21.]name21 TO [db22.]name22, ... [ON CLUSTER cluster]
Все таблицы переименовываются под глобальной блокировкой. Переименовывание таблицы является лёгкой операцией. Если вы указали после TO другую базу данных, то таблица будет перенесена в эту базу данных. При этом, директории с базами данных должны быть расположены в одной файловой системе (иначе возвращается ошибка). Все таблицы переименовываются под глобальной блокировкой. Переименовывание таблицы является лёгкой операцией. Если вы указали после TO другую базу данных, то таблица будет перенесена в эту базу данных. При этом, директории с базами данных должны быть расположены в одной файловой системе (иначе возвращается ошибка).
@ -197,7 +211,7 @@ ALTER
.. code-block:: sql .. code-block:: sql
ALTER TABLE [db].name ADD|DROP|MODIFY COLUMN ... ALTER TABLE [db].name [ON CLUSTER cluster] ADD|DROP|MODIFY COLUMN ...
В запросе указывается список из одного или более действий через запятую. В запросе указывается список из одного или более действий через запятую.
Каждое действие - операция над столбцом. Каждое действие - операция над столбцом.