Class: Groonga::Schema::TableDefinition
- Inherits:
-
Object
- Object
- Groonga::Schema::TableDefinition
- Includes:
- Path
- Defined in:
- lib/groonga/schema.rb
Overview
スキーマ定義時に create_table や #create_table からブロックに渡されてくる オブジェクト
Instance Attribute Summary collapse
-
#name ⇒ Object
readonly
テーブルの名前.
Instance Method Summary collapse
-
#[](name, definition_class = nil) ⇒ Object
-
#boolean(name, options = {}) ⇒ Object
(also: #bool)
名前が name の真偽値を格納できるカラムを作成する。.
-
#column(name, type, options = {}) ⇒ Object
名前が name で型が type のカラムを作成する。.
-
#context ⇒ Object
-
#define ⇒ Object
-
#float(name, options = {}) ⇒ Object
名前が name のieee754形式の64bit浮動小数点数のカラム を作成する。.
-
#index(target_table_or_target_column_full_name, *args) ⇒ Object
target_table の target_column を対象とするインデック スカラムを作成します。複数のカラムを指定することもで きます。.
-
#initialize(name, options) ⇒ TableDefinition
constructor
A new instance of TableDefinition.
-
#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@.
Methods included from Path
#columns_directory_path, #rmdir_if_available, #tables_directory_path
Constructor Details
#initialize(name, options) ⇒ TableDefinition
Returns a new instance of TableDefinition.
787 788 789 790 791 792 793 794 |
# File 'lib/groonga/schema.rb', line 787 def initialize(name, ) @name = name @name = @name.to_s if @name.is_a?(Symbol) @definitions = [] () = @table_type = table_type end |
Instance Attribute Details
#name ⇒ Object (readonly)
テーブルの名前
784 785 786 |
# File 'lib/groonga/schema.rb', line 784 def name @name end |
Instance Method Details
#[](name, definition_class = nil) ⇒ Object
1165 1166 1167 1168 1169 1170 |
# File 'lib/groonga/schema.rb', line 1165 def [](name, definition_class=nil) @definitions.find do |definition| definition.name.to_s == name.to_s and (definition_class.nil? or definition.is_a?(definition_class)) end end |
#boolean(name, options = {}) ⇒ Object Also known as: bool
名前が name の真偽値を格納できるカラムを作成する。
options に指定可能な値は #column を参照。
1138 1139 1140 |
# File 'lib/groonga/schema.rb', line 1138 def boolean(name, ={}) column(name, "Bool", ) end |
#column(name, type, options = {}) ⇒ Object
名前が name で型が type のカラムを作成する。
853 854 855 856 857 858 859 860 861 862 |
# File 'lib/groonga/schema.rb', line 853 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 |
#context ⇒ Object
1173 1174 1175 |
# File 'lib/groonga/schema.rb', line 1173 def context [:context] || Groonga::Context.default end |
#define ⇒ Object
797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 |
# File 'lib/groonga/schema.rb', line 797 def define table = context[@name] if [:change] raise TableNotExists.new(@name) if table.nil? else if table unless same_table?(table, ) if [:force] table.remove table = nil else = raise TableCreationWithDifferentOptions.new(table, ) end end end table ||= @table_type.create() end @definitions.each do |definition| definition.define(self, table) end table end |
#float(name, options = {}) ⇒ Object
名前が name のieee754形式の64bit浮動小数点数のカラム を作成する。
options に指定可能な値は #column を参照。
1069 1070 1071 |
# File 'lib/groonga/schema.rb', line 1069 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」カラムのインデックスカラムを 指定する場合はこうなります。
937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 |
# File 'lib/groonga/schema.rb', line 937 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@.
1001 1002 1003 |
# File 'lib/groonga/schema.rb', line 1001 def integer16(name, ={}) column(name, "Int16", ) end |
#integer32(name, options = {}) ⇒ Object Also known as: integer, int32
名前が name の32bit符号付き整数のカラムを作成する。
options に指定可能な値は #column を参照。
1010 1011 1012 |
# File 'lib/groonga/schema.rb', line 1010 def integer32(name, ={}) column(name, "Int32", ) end |
#integer64(name, options = {}) ⇒ Object Also known as: int64
名前が name の64bit符号付き整数のカラムを作成する。
options に指定可能な値は #column を参照。
1020 1021 1022 |
# File 'lib/groonga/schema.rb', line 1020 def integer64(name, ={}) column(name, "Int64", ) end |
#integer8(name, options = {}) ⇒ Object Also known as: int8
Defines a 8 bit signed integer column named @name@.
991 992 993 |
# File 'lib/groonga/schema.rb', line 991 def integer8(name, ={}) column(name, "Int8", ) end |
#long_text(name, options = {}) ⇒ Object
名前が name の2Gbyte以下の文字列を格納できるカラムを 作成する。
options に指定可能な値は #column を参照。
1117 1118 1119 |
# File 'lib/groonga/schema.rb', line 1117 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 を参照。
1129 1130 1131 1132 |
# File 'lib/groonga/schema.rb', line 1129 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 は不要?)。
868 869 870 871 872 873 874 875 876 |
# File 'lib/groonga/schema.rb', line 868 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」カラムのインデックスカラムを 削除する場合はこうなります。
967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 |
# File 'lib/groonga/schema.rb', line 967 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.
885 886 887 888 889 890 891 892 893 894 |
# File 'lib/groonga/schema.rb', line 885 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 を参照。
1098 1099 1100 |
# File 'lib/groonga/schema.rb', line 1098 def short_text(name, ={}) column(name, "ShortText", ) end |
#text(name, options = {}) ⇒ Object
名前が name の64Kbyte以下の文字列を格納できるカラムを 作成する。
options に指定可能な値は #column を参照。
1108 1109 1110 |
# File 'lib/groonga/schema.rb', line 1108 def text(name, ={}) column(name, "Text", ) end |
#time(name, options = {}) ⇒ Object
名前が name の64bit符号付き整数で1970年1月1日0時0分 0秒からの経過マイクロ秒数を格納するカラムを作成する。
options に指定可能な値は #column を参照。
1078 1079 1080 |
# File 'lib/groonga/schema.rb', line 1078 def time(name, ={}) column(name, "Time", ) end |
#timestamps(options = {}) ⇒ Object
以下と同様:
table.time("updated_at")
table.time("created_at")
1088 1089 1090 1091 |
# File 'lib/groonga/schema.rb', line 1088 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@.
1149 1150 1151 |
# File 'lib/groonga/schema.rb', line 1149 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@.
1040 1041 1042 |
# File 'lib/groonga/schema.rb', line 1040 def unsigned_integer16(name, ={}) column(name, "UInt16", ) end |
#unsigned_integer32(name, options = {}) ⇒ Object Also known as: unsigned_integer, uint32
名前が name の32bit符号なし整数のカラムを作成する。
options に指定可能な値は #column を参照。
1049 1050 1051 |
# File 'lib/groonga/schema.rb', line 1049 def unsigned_integer32(name, ={}) column(name, "UInt32", ) end |
#unsigned_integer64(name, options = {}) ⇒ Object Also known as: uint64
名前が name の64bit符号なし整数のカラムを作成する。
options に指定可能な値は #column を参照。
1059 1060 1061 |
# File 'lib/groonga/schema.rb', line 1059 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@.
1030 1031 1032 |
# File 'lib/groonga/schema.rb', line 1030 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@.
1159 1160 1161 |
# File 'lib/groonga/schema.rb', line 1159 def wgs84_geo_point(name, ={}) column(name, "WGS84GeoPoint", ) end |