File: column_remove.rst

package info (click to toggle)
groonga 9.0.0-1%2Bdeb10u1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 101,496 kB
  • sloc: ansic: 608,707; ruby: 35,042; xml: 23,643; cpp: 10,319; sh: 7,453; yacc: 5,968; python: 3,033; makefile: 2,609; perl: 133
file content (57 lines) | stat: -rw-r--r-- 1,234 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
.. -*- rst -*-

.. highlightlang:: none

``column_remove``
=================

Summary
-------

column_remove - テーブルに定義されているカラムの削除

Groonga組込コマンドの一つであるcolumn_removeについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。

column_removeはテーブルに定義されているカラムを削除します。
また、付随するインデックスも削除されます。[#]_

Syntax
------
::

 column_remove table name

Usage
-----
::

 column_remove Entry body

 [true]

.. rubric:: 脚注

.. [#] マルチセクションインデックスの一部である場合も、インデックスが削除されます。

Parameters
----------

``table``

  削除対象のカラムが定義されているテーブルの名前を指定します。

``name``

  削除対象のカラム名を指定します。

Return value
------------

::

 [成功かどうかのフラグ]

``成功かどうかのフラグ``

   エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。