null+****@clear*****
null+****@clear*****
2011年 11月 28日 (月) 17:13:45 JST
Kouhei Sutou 2011-11-28 08:13:45 +0000 (Mon, 28 Nov 2011)
New Revision: 6e63bf148e9c916f1b14b9df4a3cbcc81b7963ed
Log:
[doc] list supported and unsupported SQL commands.
Modified files:
doc/source/reference.rst
Modified: doc/source/reference.rst (+107 -8)
===================================================================
--- doc/source/reference.rst 2011-11-28 07:58:29 +0000 (b5e7dc5)
+++ doc/source/reference.rst 2011-11-28 08:13:45 +0000 (3eb7621)
@@ -6,14 +6,113 @@ Reference
List of available SQL commands
------------------------------
-You can see many SQL examples in the following directory of mroonga's source tree. ::
-
- test/sql/suite/groonga_storage/t
- test/sql/suite/groonga_wrapper/t
-
-All SQL statements written there are currently available ones.
-
-(Or we can say that any SQL statements that are not written there are not supported.)
+* ``ALTER TABLE table_name ADD COLUMN column_name TEXT``
+* ``ALTER TABLE table_name ADD FULLTEXT INDEX index_name (column_name)``
+* ``ALTER TABLE table_name ADD SPATIAL KEY index_name (geometry_column_name)``
+* ``ALTER TABLE table_name ENGINE = groonga``
+* ``ALTER TABLE table_name RENAME new_table_name``
+* ``COMMIT``
+* ``CREATE FULLTEXT INDEX index_name ON table_name(column_name)``
+* ``CREATE FULLTEXT INDEX index_name ON table_name(column_name, ...)``
+* ``CREATE TABLE \`table-name-with-hyphen\` (...)``
+* ``CREATE TABLE table_name (... FULLTEXT INDEX index_name (column_name) COMMENT 'parser "TokenMecab"')``
+* ``CREATE TABLE table_name (... FULLTEXT INDEX index_name (column_name))``
+* ``CREATE TABLE table_name (... FULLTEXT INDEX index_name (column_name, ...))``
+* ``CREATE TABLE table_name (... INDEX (column_name))``
+* ``CREATE TABLE table_name (... INDEX (column_name, ...))``
+* ``CREATE TABLE table_name (... INDEX USING BTREE (column_name))``
+* ``CREATE TABLE table_name (... PRIMARY KEY (column_name))``
+* ``CREATE TABLE table_name (...) CAHRSET UTF8``
+* ``CREATE TABLE table_name (...) ENGINE=groonga COMMENT = 'ENGINE "InnoDB"'``
+* ``CREATE TABLE table_name (...) ENGINE=groonga``
+* ``CREATE TABLE table_name (\`_id\` INT)``
+* ``CREATE TABLE table_name (\`_id\` INT, KEY(_id) USING HASH)``
+* ``CREATE TABLE table_name (column_name BIGINT)``
+* ``CREATE TABLE table_name (column_name BINARY(...))``
+* ``CREATE TABLE table_name (column_name BIT)``
+* ``CREATE TABLE table_name (column_name BLOB)``
+* ``CREATE TABLE table_name (column_name CHAR(...))``
+* ``CREATE TABLE table_name (column_name DATE)``
+* ``CREATE TABLE table_name (column_name DATETIME)``
+* ``CREATE TABLE table_name (column_name DECIMAL)``
+* ``CREATE TABLE table_name (column_name DOUBLE)``
+* ``CREATE TABLE table_name (column_name ENUM(...))``
+* ``CREATE TABLE table_name (column_name FLOAT)``
+* ``CREATE TABLE table_name (column_name GEOMETRY NOT NULL)``
+* ``CREATE TABLE table_name (column_name INT PRIMARY KEY AUTO_INCREMENT)``
+* ``CREATE TABLE table_name (column_name INT UNSIGNED)``
+* ``CREATE TABLE table_name (column_name INT)``
+* ``CREATE TABLE table_name (column_name LONGBLOB)``
+* ``CREATE TABLE table_name (column_name LONGTEXT)``
+* ``CREATE TABLE table_name (column_name MEDIUMBLOB)``
+* ``CREATE TABLE table_name (column_name MEDIUMINT)``
+* ``CREATE TABLE table_name (column_name MEDIUMTEXT)``
+* ``CREATE TABLE table_name (column_name SET(...))``
+* ``CREATE TABLE table_name (column_name SMALLINT)``
+* ``CREATE TABLE table_name (column_name TEXT)``
+* ``CREATE TABLE table_name (column_name TIME)``
+* ``CREATE TABLE table_name (column_name TIMESTAMP)``
+* ``CREATE TABLE table_name (column_name TINYBLOB)``
+* ``CREATE TABLE table_name (column_name TINYINT)``
+* ``CREATE TABLE table_name (column_name TINYTEXT)``
+* ``CREATE TABLE table_name (column_name VARBINARY(...))``
+* ``CREATE TABLE table_name (column_name VARCHAR(...))``
+* ``CREATE TABLE table_name (column_name YEAR)``
+* ``DELETE FROM table_name WHERE ...``
+* ``DROP INDEX column_name ON table_name``
+* ``DROP TABLE IF EXISTS table_name, ...``
+* ``DROP TABLE \`table-name-with-hyphen\`, ...``
+* ``DROP TABLE table_name, ...``
+* ``FLUSH LOGS``
+* ``FLUSH TABLES``
+* ``INSERT INTO (geometry_column_name) VALUES (GeomFromText('POINT(...)'))``
+* ``INSERT INTO ... VALUES ...``
+* ``INSERT INTO table_name (column_name, ...) SELECT ... FROM other_table_name``
+* ``REPLACE INTO table_name SELECT ... FROM other_table_name ...``
+* ``SELECT * FROM information_schema.plugins WHERE plugin_name = "groonga"``
+* ``SELECT * FROM table_name FORCE INDEX(index_name) WHERE ...``
+* ``SELECT * FROM table_name ORDER BY column_name ASC LIMIT ...``
+* ``SELECT * FROM table_name ORDER BY column_name ASC``
+* ``SELECT * FROM table_name ORDER BY column_name DESC LIMIT ...``
+* ``SELECT * FROM table_name ORDER BY column_name DESC``
+* ``SELECT * FROM table_name ORDER BY column_name``
+* ``SELECT * FROM table_name WHERE MATCH(column_name) AGAINST("*D+ word ..." IN BOOLEAN MODE)``
+* ``SELECT * FROM table_name WHERE MATCH(column_name) AGAINST("*D- word ..." IN BOOLEAN MODE)``
+* ``SELECT * FROM table_name WHERE MATCH(column_name) AGAINST("*DOR word ..." IN BOOLEAN MODE)``
+* ``SELECT * FROM table_name WHERE MATCH(column_name) AGAINST("+word ..." IN BOOLEAN MODE)``
+* ``SELECT * FROM table_name WHERE MATCH(column_name) AGAINST("..." IN BOOLEAN MODE)``
+* ``SELECT * FROM table_name WHERE MATCH(column_name, ...) AGAINST("..." IN BOOLEAN MODE)``
+* ``SELECT * FROM table_name WHERE MBRContains(GeomFromText('LineString(...)'), geometry_column_name)``
+* ``SELECT * FROM table_name WHERE NOT MATCH(column_name) AGAINST("..." IN BOOLEAN MODE)``
+* ``SELECT * FROM table_name WHERE column_name < ...``
+* ``SELECT * FROM table_name WHERE column_name <= ...``
+* ``SELECT * FROM table_name WHERE column_name = ...``
+* ``SELECT * FROM table_name WHERE column_name > ...``
+* ``SELECT * FROM table_name WHERE column_name >= ...``
+* ``SELECT * FROM table_name WHERE column_name BETWEEN ... AND ...``
+* ``SELECT * FROM table_name``
+* ``SELECT *, MATCH(column_name) AGAINST("..." IN BOOLEAN MODE) FROM table_name WHERE MATCH(column_name) AGAINST("..." IN BOOLEAN MODE)``
+* ``SELECT FOUND_ROWS()``
+* ``SELECT SQL_CALC_FOUND_ROWS * FROM table_name WHERE MATCH(...) AGAINST("..." IN BOOLEAN MODE) ORDER BY column_name LIMIT start,n_records``
+* ``SELECT last_insert_grn_id()``
+* ``SET binlog_format="MIXED"``
+* ``SET binlog_format="ROW"``
+* ``SET binlog_format="STATEMENT"``
+* ``TRUNCATE TABLE table_name``
+* ``UPDATE table_name SET column_name = ...``
+
+List of unavailable SQL commands
+--------------------------------
+
+* ``CREATE TABLE (...) CAHRSET not_utf8``
+* ``INSERT INTO (geometry_column_name) VALUES (GeomFromText('LineString(...)'))``
+* ``INSERT INTO (...) VALUES (null)``
+* ``START TRANSACTION``
+
+I found an unlisted SQL command
+-------------------------------
+
+If you find unlisted SQL command and confirm whether the SQL command works well or not, please send a patch against `the source file <https://github.com/mroonga/mroonga/blob/master/doc/source/reference.rst>`_ to list it.
List of server variables
------------------------