flash.data

# SQLIndexSchema - AS3

Package | flash.data
Class | public class SQLIndexSchema
Inheritance | SQLIndexSchema SQLSchema Object

Language Version: | ActionScript 3.0

Runtime Versions: | 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.

Related API Elements

flash.data.SQLConnection.loadSchema()

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | database : String [read-only] The name of the database to which this schema object belongs. | SQLSchema
|  | name : String [read-only] The name of this schema object. | SQLSchema
|  | sql : String [read-only] 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
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | SQLIndexSchema(database:String, name:String, sql:String, table:String) Creates a SQLIndexSchema instance. | SQLIndexSchema
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns the string representation of the specified object. | Object
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Property Detail

### table

property

`table:String` [read-only]

Language Version: | ActionScript 3.0

Runtime Versions: | 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 Versions: | 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.

Related API Elements

flash.data.SQLConnection.getSchemaResult()
flash.data.SQLSchemaResult.indices

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00