SQLCOLUMNS()
From Recital Documentation Wiki
Purpose
Store column information to a cursor
Syntax
SQLCOLUMNS(<nStatementHandle>, <cTableName> [, "FOXPRO" | "NATIVE"] [, <cCursorName>])
See Also
CREATE CONNECTION, SQLCANCEL(), SQLCOMMIT(), SQLCONNECT(), SQLDISCONNECT(), SQLERROR(), SQLEXEC(), SQLGETPROP(), SQLMORERESULTS(), SQLPREPARE(), SQLROLLBACK(), SQLSETPROP(), SQLSTRINGCONNECT(), SQLTABLES()
Description
The SQLCOLUMNS() function is used to store column information for a specified data source table to a cursor.
The SQLCOLUMNS() function operates on the data source specified by <nStatementHandle>.
| Keywords | Description |
|---|---|
| nStatementHandle | The workarea in which the gateway data source is open |
| cTableName | The table from which the column information should be returned |
| "NATIVE" | Used to specify the format for the column information. "FOXPRO" is the default. "NATIVE" uses the data source format. The cursor column information is shown in the table below. "NATIVE" many include additional columns. |
| cCursorName | The name of the cursor to use. If cCursorName is not specified, the default name SQLRESULT is used. |
"FOXPRO" Cursor Columns:
| Column | Description |
|---|---|
| Field_name | Column name |
| Field_type | Column data type |
| Field_len | Column length |
| Field_dec | Number of decimal places |
"NATIVE" Cursor Columns:
| Column | Description |
|---|---|
| Table_qualifier | Table qualifier id |
| Table_owner | Table owner id |
| Table_name | Table name |
| Table_type | Table type |
| Column_name | Column identifier |
| Data_type | Column data type |
| Type_name | Column data type name |
| Precision | Column precision |
| Length | Data transfer size |
| Scale | Column scale |
| Radix | Base for Numeric type |
| Nullable | Null value support |
| Remarks | Table description |
Return values:
| Return Value | Description |
|---|---|
| .T. | Format is "NATIVE" and cTableName does not exist |
| .F. | Format is "FOXPRO" and cTableName does not exist |
| 1 | The table was created successfully |
| 0 | SQLCOLUMNS() still executing |
| –1 | Connection error |
| –2 | Environment error |
Example
nStatHand=SQLSTRINGCONNECT("mysql@linux1:user1/pass1-database1.tcpip",.T.) if nStatHand < 1 dialog box [Could not connect] else nColEnd = SQLCOLUMNS(nStatHand, "accounts", "NATIVE", "tabinfo") if nColEnd = 1 select tabinfo browse else dialog box [Table of Table Information could not be created] endif endif
Products
Recital, Recital Server
