rroonga 7.0.2-x86-mingw32 → 7.1.1-x86-mingw32

data/vendor/local/share/doc/groonga/en/html/_sources/reference/commands/dump.txt

@@ -1,202 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-.. groonga-command
-.. database: commands_dump
-
-``dump``
-========
-
-Summary
--------
-
-dump - データベースのスキーマとデータを出力する
-
-Groonga組込コマンドの一つであるdumpについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、
-またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
-
-dumpはデータベースのスキーマとデータを後から読み込めるフォーマットで出力します。dumpの結果は大きくなるため、
-主にコマンドラインから使うことを想定しています。データベースのバックアップが主な利用方法です。
-
-dumpが出力するフォーマットは直接Groongaが解釈できるフォーマットです。そのため、以下のようにしてデータベース>をコピーすることができます。::
-
-  % groonga original/db dump > dump.grn
-  % mkdir backup
-  % groonga -n backup/db < dump.grn
-
-Syntax
-------
-::
-
-   dump [tables]
-        [dump_plugins]
-        [dump_schema]
-        [dump_records]
-        [dump_indexes]
-
-Usage
------
-
-Here is the sample schema and data to check dump behaviour::
-
-  plugin_register token_filters/stop_word
-  table_create Bookmarks TABLE_HASH_KEY ShortText
-  column_create Bookmarks title COLUMN_SCALAR ShortText
-  table_create Lexicon TABLE_PAT_KEY ShortText
-  table_create Sites TABLE_NO_KEY
-  column_create Sites url COLUMN_SCALAR ShortText
-  column_create Lexicon bookmark_title COLUMN_INDEX Bookmarks title
-  load --table Bookmarks
-  [
-  {"_key":"Groonga", "title":"Introduction to Groonga"},
-  {"_key":"Mroonga", "title":"Introduction to Mroonga"}
-  ]
-  load --table Sites
-  [
-  {"_key": 1, "url":"http://groonga.org"},
-  {"_key": 2, "url":"http://mroonga.org"}
-  ]
-
-Dump all data in database::
-
-  > dump
-  plugin_register token_filters/stop_word
-  
-  table_create Sites TABLE_NO_KEY
-  column_create Sites url COLUMN_SCALAR ShortText
-  
-  table_create Bookmarks TABLE_HASH_KEY ShortText
-  column_create Bookmarks title COLUMN_SCALAR ShortText
-  
-  table_create Lexicon TABLE_PAT_KEY ShortText
-  
-  load --table Sites
-  [
-  ["_id","url"],
-  [1,"http://groonga.org"],
-  [2,"http://mroonga.org"]
-  ]
-  
-  load --table Bookmarks
-  [
-  ["_key","title"],
-  ["Groonga","Introduction to Groonga"],
-  ["Mroonga","Introduction to Mroonga"]
-  ]
-  
-  create Lexicon bookmark_title COLUMN_INDEX Bookmarks title
-
-Dump schema and specific table data::
-
-  > dump Bookmarks
-  plugin_register token_filters/stop_word
-  
-  table_create Sites TABLE_NO_KEY
-  column_create Sites url COLUMN_SCALAR ShortText
-  
-  table_create Bookmarks TABLE_HASH_KEY ShortText
-  column_create Bookmarks title COLUMN_SCALAR ShortText
-  
-  table_create Lexicon TABLE_PAT_KEY ShortText
-  
-  load --table Bookmarks
-  [
-  ["_key","title"],
-  ["Groonga","Introduction to Groonga"],
-  ["Mroonga","Introduction to Mroonga"]
-  ]
-  
-  column_create Lexicon bookmark_title COLUMN_INDEX Bookmarks title
-
-Dump plugin only::
-
-  > dump --dump_schema no --dump_records no --dump_indexes no
-  plugin_register token_filters/stop_word
-
-Dump records only::
-
-  > dump --dump_schema no --dump_plugins no --dump_indexes no
-  load --table Sites
-  [
-  ["_id","url"],
-  [1,"http://groonga.org"],
-  [2,"http://mroonga.org"]
-  ]
-  
-  load --table Bookmarks
-  [
-  ["_key","title"],
-  ["Groonga","Introduction to Groonga"],
-  ["Mroonga","Introduction to Mroonga"]
-  ]
-
-Dump schema only::
-
-  > dump --dump_records no --dump_plugins no --dump_indexes no
-  table_create Sites TABLE_NO_KEY
-  column_create Sites url COLUMN_SCALAR ShortText
-  
-  table_create Bookmarks TABLE_HASH_KEY ShortText
-  column_create Bookmarks title COLUMN_SCALAR ShortText
-  
-  table_create Lexicon TABLE_PAT_KEY ShortText
-
-Parameters
-----------
-
-There are optional parameters.
-
-Optional parameters
-^^^^^^^^^^^^^^^^^^^
-
-``tables``
-""""""""""
-
-出力対象のテーブルを「,」（カンマ）区切りで指定します。存在しないテーブルを指定した場合は無視されます。
-
-``dump_plugins``
-""""""""""""""""
-
-.. versionadded:: 5.0.3
-
-You can customize the output whether it contains registered plugins or not.
-To exclude registered plugins from the output, specify ``no``.
-
-The default value is ``yes``.
-
-``dump_schema``
-"""""""""""""""
-
-.. versionadded:: 5.0.3
-
-You can customize the output whether it contains database schema or not.
-To exclude database schema from the output, specify ``no``.
-
-The default value is ``yes``.
-
-``dump_records``
-""""""""""""""""
-
-.. versionadded:: 5.0.3
-
-You can customize the output whether it contains records or not.
-To exclude records from the output, specify ``no``.
-
-The default value is ``yes``.
-
-``dump_indexes``
-""""""""""""""""
-
-.. versionadded:: 5.0.3
-
-You can customize the output whether it contains indexes or not.
-To exclude indexes from the output, specify ``no``.
-
-The default value is ``yes``.
-
-Return value
-------------
-
-データベースのスキーマとデータをGroongaの組み込みコマンド呼び出し形式で出力します。output_type指定は無視されます。
-

data/vendor/local/share/doc/groonga/en/html/_sources/reference/commands/io_flush.txt

@@ -1,266 +0,0 @@
-.. -*- rst -*-
-
-.. highlightlang:: none
-
-.. groonga-command
-.. database: commands_io_flush
-
-``io_flush``
-============
-
-Summary
--------
-
-.. versionadded:: 5.0.5
-
-``io_flush`` flushes all changes in memory to disk
-explicitly. Normally, you don't need to use ``io_flush``
-explicitly. Because flushing is done automatically by OS. And flushing
-by OS is effective.
-
-You need to use ``io_flush`` explicitly when your system may often
-crash unexpectedly or you may not shutdown your Groonga process in a
-normal way. (For example, using :doc:`shutdown` is a normal shutdown
-process.) It's better that you use ``io_flush`` after you change your
-Groonga database for the case. Here are commands that change your
-Groonga database:
-
-  * :doc:`load`
-  * :doc:`delete`
-  * :doc:`truncate`
-  * :doc:`table_create`
-  * :doc:`table_remove`
-  * :doc:`table_rename`
-  * :doc:`column_create`
-  * :doc:`column_remove`
-  * :doc:`column_rename`
-  * :doc:`plugin_register`
-  * :doc:`plugin_unregister`
-  * :doc:`logical_table_remove`
-
-If you're using :ref:`select-scorer` parameter in :doc:`select` to
-change existing column values, :doc:`select` is added to the above
-list.
-
-Note that ``io_flush`` may be a heavy process. If there are many
-changes in memory, flushing them to disk is a heavy process.
-
-Syntax
-------
-
-This command takes two parameters.
-
-All parameters are optional::
-
-  io_flush [target_name=null]
-           [recursive=yes]
-
-Usage
------
-
-You can flush all changes in memory to disk with no arguments:
-
-.. groonga-command
-.. include:: ../../example/reference/commands/io_flush/all.log
-.. io_flush
-
-If you know what is changed, you can narrow flush targets. Here is a
-correspondence table between command and flush targets.
-
-.. list-table::
-   :header-rows: 1
-
-   * - Command
-     - Flush targets
-     - ``io_flush`` arguments
-   * - :doc:`load` and :doc:`delete`
-     - Target table and its columns.
-
-       If there are one or more reference columns in these columns,
-       referenced tables are also flush targets.
-
-       If there are one or more indexed columns in these columns,
-       tables of corresponding index columns and corresponding index
-       columns are also flush targets.
-     - Table and its columns::
-
-         io_flush --target_name TABLE_NAME
-
-       A referenced table::
-
-         io_flush --target_name REFERENCED_TABLE_NAME --recursive no
-
-       A table of an index column::
-
-         io_flush --target_name TABLE_NAME_OF_INDEX_COLUMN --recursive no
-
-       An index column::
-
-         io_flush --target_name TABLE_NAME_OF_INDEX_COLUMN.INDEX_COLUMN
-   * - :doc:`truncate`
-     - Target table and its columns.
-
-       If there are one or more reference columns in these columns,
-       referenced tables are also flush targets.
-
-       If there are one or more indexed columns in these columns,
-       tables of corresponding index columns and corresponding index
-       columns are also flush targets.
-
-       Database is also flush target.
-     - Table and its columns::
-
-         io_flush --target_name TABLE_NAME
-
-       A referenced table::
-
-         io_flush --target_name REFERENCED_TABLE_NAME --recursive no
-
-       A table of an index column::
-
-         io_flush --target_name TABLE_NAME_OF_INDEX_COLUMN --recursive no
-
-       An index column::
-
-         io_flush --target_name TABLE_NAME_OF_INDEX_COLUMN.INDEX_COLUMN
-
-       Database::
-
-         io_flush --recursive no
-   * - :doc:`table_create`
-     - Target table and database.
-     - Table::
-
-         io_flush --target_name TABLE_NAME
-
-       Database::
-
-         io_flush --recursive no
-   * - :doc:`table_remove`, :doc:`table_rename` and :doc:`logical_table_remove`
-     - Database.
-     - Database::
-
-         io_flush --recursive no
-   * - :doc:`column_create`
-     - Target column and database.
-     - Table::
-
-         io_flush --target_name TABLE_NAME.COLUMN_NAME
-
-       Database::
-
-         io_flush --recursive no
-   * - :doc:`column_remove` and :doc:`column_rename`
-     - Database.
-     - Database::
-
-         io_flush --recursive no
-   * - :doc:`plugin_register` and :doc:`plugin_unregister`
-     - Database.
-     - Database::
-
-         io_flush --recursive no
-
-
-Parameters
-----------
-
-This section describes all parameters.
-
-Required parameters
-^^^^^^^^^^^^^^^^^^^
-
-There is no required parameter.
-
-Optional parameters
-^^^^^^^^^^^^^^^^^^^
-
-There are optional parameters.
-
-.. _io-flush-target-name:
-
-``target_name``
-"""""""""""""""
-
-Specifies a flush target object name. Target object is one of
-database, table or column.
-
-If you omit this parameter, database is flush target object:
-
-.. groonga-command
-.. include:: ../../example/reference/commands/io_flush/target_name_database.log
-.. io_flush
-
-If you specify table name, the table is flush target object:
-
-.. groonga-command
-.. include:: ../../example/reference/commands/io_flush/target_name_table.log
-.. table_create Users TABLE_HASH_KEY ShortText
-.. io_flush --target_name Users
-
-If you specify column name, the column is flush target object:
-
-.. groonga-command
-.. include:: ../../example/reference/commands/io_flush/target_name_column.log
-.. column_create Users age COLUMN_SCALAR UInt8
-.. io_flush --target_name Users.age
-
-.. _io-flush-recursive:
-
-``recursive``
-"""""""""""""
-
-Specifies whether child objects of the flush target object are also
-flush target objects.
-
-Child objects of database is all tables and all columns.
-
-Child objects of table is all its columns.
-
-Child objects of column is nothing.
-
-``recursive`` value must be ``yes`` or ``no``. ``yes`` means that all
-of the specified flush target object and child objects are flush
-target objects. ``no`` means that only the specified flush target
-object is flush target object.
-
-The following ``io_flush`` flushes all changes in database, all tables
-and all columns:
-
-.. groonga-command
-.. include:: ../../example/reference/commands/io_flush/recursive_yes.log
-.. io_flush --recursive yes
-
-The following ``io_flush`` flushes all changes only in database:
-
-.. groonga-command
-.. include:: ../../example/reference/commands/io_flush/recursive_no.log
-.. io_flush --recursive no
-
-If you specify other value (not ``yes`` neither ``no``) or omit
-``recursive`` parameter, ``yes`` is used.
-
-``yes`` is used in the following case because invalid ``recursive``
-argument is specified:
-
-.. groonga-command
-.. include:: ../../example/reference/commands/io_flush/recursive_invalid.log
-.. io_flush --recursive invalid
-
-``yes`` is used in the following case because ``recursive`` parameter
-isn't specified:
-
-.. groonga-command
-.. include:: ../../example/reference/commands/io_flush/recursive_default.log
-.. io_flush
-
-Return value
-------------
-
-The command returns ``true`` as body on success such as::
-
-  [HEADER, true]
-
-If the command fails, error details are in ``HEADER``.
-
-See :doc:`/reference/command/output_format` for ``HEADER``.