| Package | flash.data |
| Class | public class SQLSchema |
| Inheritance | SQLSchema  Object |
| Subclasses | SQLIndexSchema, SQLTableSchema, SQLTriggerSchema |
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0 |
To obtain schema information for a database, use the
SQLConnection.loadSchema() method to load the schema information.
The resulting SQLSchemaResult instance contains arrays of instances representing the objects
in the database.
Generally, developer code does not construct SQLSchema instances directly.
Related API Elements
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 | ||
| Method | Defined By | ||
|---|---|---|---|
Creates a SQLSchema instance. | SQLSchema | ||
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
database | property |
database:String [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0 |
The name of the database to which this schema object belongs. The name is "main" for the main
database associated with a SQLConnection instance (the database file that is
opened by calling a SQLConnection instance's open() or openAsync() method). For other
databases that are attached to the connection using the
SQLConnection.attach() method, the value is the name specified in the attach()
method call.
Implementation
public function get database():StringRelated API Elements
name | property |
name:String [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0 |
The name of this schema object. Each object within a
database has a unique name. The name is defined in the SQL statement that creates the object
(such as the CREATE TABLE statement for a table).
For example, if a database index is created using the following SQL statement, the value of the
name property for that index's schema would be "customer_index":
CREATE INDEX customer_index ON customers (id)
Implementation
public function get name():String sql | property |
sql:String [read-only] | Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0 |
Returns the entire text of the SQL statement that was used to create this schema object. Each object within a database is created using a SQL statement.
For example, if a database index is created using the following SQL:
CREATE INDEX customer_index ON customers (id)
the sql property for that index's schema would be the entire text of
the statement.
Implementation
public function get sql():String SQLSchema | () | Constructor |
public function SQLSchema(database:String, name:String, sql:String)| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0 |
Creates a SQLSchema instance. Generally, developer code does not call the SQLSchema
constructor directly. To obtain schema information for a database, call the
SQLConnection.loadSchema() method.
database:String — The name of the associated database.
| |
name:String — The name of the database object.
| |
sql:String — The SQL used to construct the database
object.
|
Wed Nov 21 2018, 06:34 AM -08:00