Packageflash.data
Classpublic class SQLIndexSchema
InheritanceSQLIndexSchema Inheritance SQLSchema Inheritance Object

Language version: ActionScript 3.0
Runtime version: AIR 1.0

A SQLIndexSchema instance provides information describing a specific index in a database. The available information includes the name of the associated table (the table property), the SQL statement used to create the index (the sql property), and the name of the index (the name property).

To obtain index schema information for a database, use the SQLConnection.loadSchema() method to load the schema information, making certain to use null or SQLIndexSchema for the type argument's value. In the resulting SQLSchemaResult instance, the indices property contains an array of SQLIndexSchema instances representing the indices in the database.

Generally, developer code does not construct SQLIndexSchema instances directly.

See also

flash.data.SQLConnection.loadSchema()


Public Properties
 PropertyDefined by
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 Inheriteddatabase : String
The name of the database to which this schema object belongs.
SQLSchema
 Inheritedname : String
The name of this schema object.
SQLSchema
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 Inheritedsql : String
Returns the entire text of the SQL statement that was used to create this schema object.
SQLSchema
  table : String
[read-only] The name of the table to which this index is attached.
SQLIndexSchema
Public Methods
 MethodDefined by
  
SQLIndexSchema(database:String, name:String, sql:String, table:String)
Creates a SQLIndexSchema instance.
SQLIndexSchema
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Property detail
tableproperty
table:String  [read-only]

Language version: ActionScript 3.0
Runtime version: AIR 1.0

The name of the table to which this index is attached.

Implementation
    public function get table():String
Constructor detail
SQLIndexSchema()constructor
public function SQLIndexSchema(database:String, name:String, sql:String, table:String)

Language version: ActionScript 3.0
Runtime version: AIR 1.0

Creates a SQLIndexSchema instance. Generally, developer code does not call the SQLIndexSchema constructor directly. To obtain schema information for a database, call the SQLConnection.loadSchema() method.

Parameters
database:String — The name of the associated database.
 
name:String — The name of the index.
 
sql:String — The SQL statement used to create this index.
 
table:String — The name of the table to which this index is attached.

See also