File: column_remove.rst

package info (click to toggle)
groonga 15.0.4%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 163,080 kB
  • sloc: ansic: 770,564; cpp: 48,925; ruby: 40,447; javascript: 10,250; yacc: 7,045; sh: 5,602; python: 2,821; makefile: 1,672
file content (55 lines) | stat: -rw-r--r-- 1,209 bytes parent folder | download | duplicates (3)
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
.. -*- rst -*-

``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を返す。