class Scenic::Index
The in-memory representation of a database index.
**This object is used internally by adapters and the schema dumper and is not intended to be used by application code. It is documented here for use by adapter gems.**
@api extension
Attributes
The SQL statement that defines the index @return [String]
@example
"CREATE INDEX index_users_on_email ON users USING btree (email)"
The name of the index @return [String]
The name of the object that has the index @return [String]
Public Class Methods
Source
# File lib/scenic/index.rb, line 30 def initialize(object_name:, index_name:, definition:) @object_name = object_name @index_name = index_name @definition = definition end
Returns a new instance of Index
@param object_name
[String] The name of the object that has the index @param index_name
[String] The name of the index @param definition [String] The SQL statements that defined the index