Database

From Yate Documentation
Jump to: navigation, search

database is used by various modules to request a database query operation.

Contents

Mandatory parameters

account
Name that identifies a connection to a database server.

Optional parameters

query
SQL query to execute
results
Set to "false" to prevent SELECT results from being returned

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.

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

Personal tools
Namespaces

Variants
Actions
Preface
Configuration
Administrators
Developers