Adobe® Flex® 4 Language Reference
Hide Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
flash.data 
SQLTableSchema 
Packageflash.data
Classpublic class SQLTableSchema
InheritanceSQLTableSchema Inheritance SQLSchema Inheritance Object
Subclasses SQLViewSchema

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

A SQLTableSchema instance provides information describing a specific table in a database. It contains the name of the table (the name property), the SQL statement used to create the table (the sql property), and information about the table's columns (the columns property).

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

Generally, developer code does not construct SQLTableSchema instances directly.

See also



Public Properties
 PropertyDefined By
  AIR-only columns : Array
[read-only] An array of SQLColumnSchema instances containing schema information for this table's columns.
SQLTableSchema
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedAIR-only database : String
[read-only] The name of the database to which this schema object belongs.
SQLSchema
 InheritedAIR-only name : String
[read-only] The name of this schema object.
SQLSchema
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 InheritedAIR-only sql : String
[read-only] Returns the entire text of the SQL statement that was used to create this schema object.
SQLSchema
Public Methods
 MethodDefined By
  
AIR-only SQLTableSchema(database:String, name:String, sql:String, columns:Array)
Creates a SQLTableSchema instance.
SQLTableSchema
 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
AIR-only 

columns

property
columns:Array  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

An array of SQLColumnSchema instances containing schema information for this table's columns. If the SQlConnection.loadSchema() call indicates that column information is excluded from the result, the columns property is an empty array (an array whose length property is 0).



Implementation
    public function get columns():Array

See also

Constructor Detail
AIR-only 

SQLTableSchema

()Constructor
public function SQLTableSchema(database:String, name:String, sql:String, columns:Array)

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

Creates a SQLTableSchema instance. Generally, developer code does not call the SQLTableSchema 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 table.
 
sql:String — The SQL statement used to create the table.
 
columns:Array — Array of SQLColumnSchema instances describing this table's columns.

See also