flash.data.SQLTableSchema - Adobe® Flex® 4 Language Reference (Flex 4)

Package	flash.data
Class	public class SQLTableSchema
Inheritance	SQLTableSchema SQLSchema 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.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		columns : Array [read-only] An array of SQLColumnSchema instances containing schema information for this table's columns.	SQLTableSchema
		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
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		sql : String [read-only] Returns the entire text of the SQL statement that was used to create this schema object.	SQLSchema

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		SQLTableSchema(database:String, name:String, sql:String, columns:Array) Creates a SQLTableSchema instance.	SQLTableSchema
		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

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

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.