Class: Groonga::Schema::TableDefinition
- Inherits:
-
Object
- Object
- Groonga::Schema::TableDefinition
- Defined in:
- lib/groonga/schema.rb
Overview
スキーマ定義時に create_table や #create_table からブロックに渡されてくる オブジェクト
Instance Attribute Summary collapse
-
#name ⇒ Object
readonly
テーブルの名前.
Instance Method Summary collapse
-
#boolean(name, options = {}) ⇒ Object
(also: #bool)
名前が name の真偽値を格納できるカラムを作成する。.
-
#column(name, type, options = {}) ⇒ Object
名前が name で型が type のカラムを作成する。.
-
#float(name, options = {}) ⇒ Object
名前が name のieee754形式の64bit浮動小数点数のカラム を作成する。.
-
#index(target_table_or_target_column_full_name, *args) ⇒ Object
target_table の target_column を対象とするインデック スカラムを作成します。複数のカラムを指定することもで きます。.
-
#integer16(name, options = {}) ⇒ Object
(also: #int16)
Defines a 16 bit signed integer column named @name@.
-
#integer32(name, options = {}) ⇒ Object
(also: #integer, #int32)
名前が name の32bit符号付き整数のカラムを作成する。.
-
#integer64(name, options = {}) ⇒ Object
(also: #int64)
名前が name の64bit符号付き整数のカラムを作成する。.
-
#integer8(name, options = {}) ⇒ Object
(also: #int8)
Defines a 8 bit signed integer column named @name@.
-
#long_text(name, options = {}) ⇒ Object
名前が name の2Gbyte以下の文字列を格納できるカラムを 作成する。.
-
#reference(name, table = nil, options = {}) ⇒ Object
名前が name で table のレコードIDを格納する参照カラ ムを作成する。.
-
#remove_column(name, options = {}) ⇒ Object
名前が name のカラムを削除します。.
-
#remove_index(target_table_or_target_column_full_name, *args) ⇒ Object
target_table の target_column を対象とするインデッ クスカラムを削除します。.
-
#rename_column(current_name, new_name, options = {}) ⇒ Object
Renames current_name column to new_name column.
-
#short_text(name, options = {}) ⇒ Object
(also: #string)
名前が name の4Kbyte以下の文字列を格納できるカラムを 作成する。.
-
#text(name, options = {}) ⇒ Object
名前が name の64Kbyte以下の文字列を格納できるカラムを 作成する。.
-
#time(name, options = {}) ⇒ Object
名前が name の64bit符号付き整数で1970年1月1日0時0分 0秒からの経過マイクロ秒数を格納するカラムを作成する。.
-
#timestamps(options = {}) ⇒ Object
以下と同様: <pre> !!!ruby table.time(“updated_at”) table.time(“created_at”) </pre>.
-
#tokyo_geo_point(name, options = {}) ⇒ Object
Defines a geo point in Tokyo geodetic system column named @name@.
-
#unsigned_integer16(name, options = {}) ⇒ Object
(also: #uint16)
Defines a 16 bit unsigned integer column named @name@.
-
#unsigned_integer32(name, options = {}) ⇒ Object
(also: #unsigned_integer, #uint32)
名前が name の32bit符号なし整数のカラムを作成する。.
-
#unsigned_integer64(name, options = {}) ⇒ Object
(also: #uint64)
名前が name の64bit符号なし整数のカラムを作成する。.
-
#unsigned_integer8(name, options = {}) ⇒ Object
(also: #uint8)
Defines a 8 bit unsigned integer column named @name@.
-
#wgs84_geo_point(name, options = {}) ⇒ Object
(also: #geo_point)
Defines a geo point in WGS 84 (World Geodetic System) column named @name@.
Instance Attribute Details
#name ⇒ Object (readonly)
テーブルの名前
799 800 801 |
# File 'lib/groonga/schema.rb', line 799 def name @name end |
Instance Method Details
#boolean(name, options = {}) ⇒ Object Also known as: bool
名前が name の真偽値を格納できるカラムを作成する。
options に指定可能な値は #column を参照。
1155 1156 1157 |
# File 'lib/groonga/schema.rb', line 1155 def boolean(name, ={}) column(name, "Bool", ) end |
#column(name, type, options = {}) ⇒ Object
名前が name で型が type のカラムを作成する。
870 871 872 873 874 875 876 877 878 879 |
# File 'lib/groonga/schema.rb', line 870 def column(name, type, ={}) definition = self[name, ColumnDefinition] if definition.nil? definition = ColumnDefinition.new(name, ) update_definition(name, ColumnDefinition, definition) end definition.type = type definition..merge!(.merge()) self end |
#float(name, options = {}) ⇒ Object
名前が name のieee754形式の64bit浮動小数点数のカラム を作成する。
options に指定可能な値は #column を参照。
1086 1087 1088 |
# File 'lib/groonga/schema.rb', line 1086 def float(name, ={}) column(name, "Float", ) end |
#index(target_table_or_target_column_full_name, *args) ⇒ Object
target_table の target_column を対象とするインデック スカラムを作成します。複数のカラムを指定することもで きます。
target_column_full_name で指定するときはテーブル名 とカラム名を”.”でつなげます。
例えば、「Users」テーブルの「name」カラムのインデックスカラムを 指定する場合はこうなります。
954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 |
# File 'lib/groonga/schema.rb', line 954 def index(target_table_or_target_column_full_name, *args) key, target_table, target_columns, = parse_index_argument(target_table_or_target_column_full_name, *args) name = .delete(:name) definition = self[key, IndexColumnDefinition] if definition.nil? definition = IndexColumnDefinition.new(name, ) update_definition(key, IndexColumnDefinition, definition) end definition.target_table = target_table definition.target_columns = target_columns definition..merge!(.merge()) self end |
#integer16(name, options = {}) ⇒ Object Also known as: int16
Defines a 16 bit signed integer column named @name@.
1018 1019 1020 |
# File 'lib/groonga/schema.rb', line 1018 def integer16(name, ={}) column(name, "Int16", ) end |
#integer32(name, options = {}) ⇒ Object Also known as: integer, int32
名前が name の32bit符号付き整数のカラムを作成する。
options に指定可能な値は #column を参照。
1027 1028 1029 |
# File 'lib/groonga/schema.rb', line 1027 def integer32(name, ={}) column(name, "Int32", ) end |
#integer64(name, options = {}) ⇒ Object Also known as: int64
名前が name の64bit符号付き整数のカラムを作成する。
options に指定可能な値は #column を参照。
1037 1038 1039 |
# File 'lib/groonga/schema.rb', line 1037 def integer64(name, ={}) column(name, "Int64", ) end |
#integer8(name, options = {}) ⇒ Object Also known as: int8
Defines a 8 bit signed integer column named @name@.
1008 1009 1010 |
# File 'lib/groonga/schema.rb', line 1008 def integer8(name, ={}) column(name, "Int8", ) end |
#long_text(name, options = {}) ⇒ Object
名前が name の2Gbyte以下の文字列を格納できるカラムを 作成する。
options に指定可能な値は #column を参照。
1134 1135 1136 |
# File 'lib/groonga/schema.rb', line 1134 def long_text(name, ={}) column(name, "LongText", ) end |
#reference(name, table = nil, options = {}) ⇒ Object
名前が name で table のレコードIDを格納する参照カラ ムを作成する。
table が省略された場合は name の複数形が使われる。 例えば、 name が”user”な場合は table は”users”になる。
options に指定可能な値は #column を参照。
1146 1147 1148 1149 |
# File 'lib/groonga/schema.rb', line 1146 def reference(name, table=nil, ={}) table ||= lambda {|context| guess_table_name(context, name)} column(name, table, ) end |
#remove_column(name, options = {}) ⇒ Object
名前が name のカラムを削除します。
options に指定可能な値はありません(TODO options は不要?)。
885 886 887 888 889 890 891 892 893 |
# File 'lib/groonga/schema.rb', line 885 def remove_column(name, ={}) definition = self[name, ColumnRemoveDefinition] if definition.nil? definition = ColumnRemoveDefinition.new(name, ) update_definition(name, ColumnRemoveDefinition, definition) end definition..merge!() self end |
#remove_index(target_table_or_target_column_full_name, *args) ⇒ Object
target_table の target_column を対象とするインデッ クスカラムを削除します。
target_column_full_name で指定するときはテーブル名 とカラム名を”.”でつなげます。
例えば、「Users」テーブルの「name」カラムのインデックスカラムを 削除する場合はこうなります。
984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 |
# File 'lib/groonga/schema.rb', line 984 def remove_index(target_table_or_target_column_full_name, *args) key, target_table, target_columns, = parse_index_argument(target_table_or_target_column_full_name, *args) name = .delete(:name) name ||= lambda do |context| IndexColumnDefinition.column_name(context, target_table, target_columns) end definition = self[key, ColumnRemoveDefinition] if definition.nil? definition = ColumnRemoveDefinition.new(name, ) update_definition(key, ColumnRemoveDefinition, definition) end definition..merge!() self end |
#rename_column(current_name, new_name, options = {}) ⇒ Object
Renames current_name column to new_name column.
902 903 904 905 906 907 908 909 910 911 |
# File 'lib/groonga/schema.rb', line 902 def rename_column(current_name, new_name, ={}) definition = self[name, ColumnRenameDefinition] if definition.nil? definition = ColumnRenameDefinition.new(current_name, new_name, ) update_definition(name, ColumnRenameDefinition, definition) end definition..merge!() self end |
#short_text(name, options = {}) ⇒ Object Also known as: string
名前が name の4Kbyte以下の文字列を格納できるカラムを 作成する。
options に指定可能な値は #column を参照。
1115 1116 1117 |
# File 'lib/groonga/schema.rb', line 1115 def short_text(name, ={}) column(name, "ShortText", ) end |
#text(name, options = {}) ⇒ Object
名前が name の64Kbyte以下の文字列を格納できるカラムを 作成する。
options に指定可能な値は #column を参照。
1125 1126 1127 |
# File 'lib/groonga/schema.rb', line 1125 def text(name, ={}) column(name, "Text", ) end |
#time(name, options = {}) ⇒ Object
名前が name の64bit符号付き整数で1970年1月1日0時0分 0秒からの経過マイクロ秒数を格納するカラムを作成する。
options に指定可能な値は #column を参照。
1095 1096 1097 |
# File 'lib/groonga/schema.rb', line 1095 def time(name, ={}) column(name, "Time", ) end |
#timestamps(options = {}) ⇒ Object
以下と同様:
table.time("updated_at")
table.time("created_at")
1105 1106 1107 1108 |
# File 'lib/groonga/schema.rb', line 1105 def (={}) time("created_at", ) time("updated_at", ) end |
#tokyo_geo_point(name, options = {}) ⇒ Object
Defines a geo point in Tokyo geodetic system column named @name@.
1166 1167 1168 |
# File 'lib/groonga/schema.rb', line 1166 def tokyo_geo_point(name, ={}) column(name, "TokyoGeoPoint", ) end |
#unsigned_integer16(name, options = {}) ⇒ Object Also known as: uint16
Defines a 16 bit unsigned integer column named @name@.
1057 1058 1059 |
# File 'lib/groonga/schema.rb', line 1057 def unsigned_integer16(name, ={}) column(name, "UInt16", ) end |
#unsigned_integer32(name, options = {}) ⇒ Object Also known as: unsigned_integer, uint32
名前が name の32bit符号なし整数のカラムを作成する。
options に指定可能な値は #column を参照。
1066 1067 1068 |
# File 'lib/groonga/schema.rb', line 1066 def unsigned_integer32(name, ={}) column(name, "UInt32", ) end |
#unsigned_integer64(name, options = {}) ⇒ Object Also known as: uint64
名前が name の64bit符号なし整数のカラムを作成する。
options に指定可能な値は #column を参照。
1076 1077 1078 |
# File 'lib/groonga/schema.rb', line 1076 def unsigned_integer64(name, ={}) column(name, "UInt64", ) end |
#unsigned_integer8(name, options = {}) ⇒ Object Also known as: uint8
Defines a 8 bit unsigned integer column named @name@.
1047 1048 1049 |
# File 'lib/groonga/schema.rb', line 1047 def unsigned_integer8(name, ={}) column(name, "UInt8", ) end |
#wgs84_geo_point(name, options = {}) ⇒ Object Also known as: geo_point
Defines a geo point in WGS 84 (World Geodetic System) column named @name@.
1176 1177 1178 |
# File 'lib/groonga/schema.rb', line 1176 def wgs84_geo_point(name, ={}) column(name, "WGS84GeoPoint", ) end |