Database
From Yate Documentation
(Difference between revisions)
(Created page with " '''database''' is used by various modules to request a database query operation. ===Mandatory parameters=== ;account : Name that identifies a connection to a database se...") |
|||
| Line 32: | Line 32: | ||
;affected | ;affected | ||
: Number of rows affected by the operation; the exact meaning depends on the database driver | : Number of rows affected by the operation; the exact meaning depends on the database driver | ||
| + | |||
| + | |||
| + | '''See also''' | ||
| + | |||
| + | * [[monitor.query]] | ||
Latest revision as of 12:58, 23 January 2013
database is used by various modules to request a database query operation.
Contents |
[edit] Mandatory parameters
- account
- Name that identifies a connection to a database server.
[edit] Optional parameters
- query
- SQL query to execute
- results
- Set to "false" to prevent SELECT results from being returned
[edit] Return value
A database module that handles this message should acknowledge the message.
If a SELECT type query was executed the result set is returned in an Array attached to the message as userData. The first row of the array is used to store the returned field names.
[edit] Return parameters
- dbtype
- Type of the database driver that handles the account
- error
- Keyword identifying if an error has occured; currently only "failure" may be returned
- columns
- Number of fields in the result set, if any
- rows
- Number of rows in the result set
- affected
- Number of rows affected by the operation; the exact meaning depends on the database driver
See also
