Phonebot developer's reference/Object reference/Managing databases in Phonebot applications - Revision history

Sstrader: Managing databases in Phonebot applications moved to Phonebot developer's reference/Object reference/Managing databases in Phonebot applications

2012-08-07T11:29:10Z

Managing databases in Phonebot applications moved to Phonebot developer's reference/Object reference/Managing databases in Phonebot applications

Sstrader at 03:33, 21 June 2012

2012-06-21T03:33:49Z

Sstrader: /* Record */

2012-06-21T03:31:52Z

‎Record

Sstrader: /* Object reference */

2012-06-21T03:31:15Z

‎Object reference

Sstrader at 03:30, 21 June 2012

2012-06-21T03:30:25Z

Sstrader at 03:29, 21 June 2012

2012-06-21T03:29:24Z

Sstrader at 02:54, 3 May 2012

2012-05-03T02:54:23Z

Sstrader at 02:47, 3 May 2012

2012-05-03T02:47:58Z

Sstrader at 02:47, 3 May 2012

2012-05-03T02:47:11Z

Sstrader at 02:46, 3 May 2012

2012-05-03T02:46:13Z

New page

A database is a collection of data accessed by a unique name. Databases map to tables in SQL. Database records are accessed by their zero-based index. Fields within records are accessed by their zero-based index or by their field name.

* Use [[Phonebot_developer%27s_reference/Object_reference#Application|Application]] to manage databases in an application
* Use [[Phonebot_developer%27s_reference/Object_reference#Database|Database]] to manage fields and records in a database
* Use [[Phonebot_developer%27s_reference/Object_reference#Record|Record]] to manage field values in a record

Properties

{|class="wikitable sortable"
|-
!Syntax
!Description
|-
|<code>exists</code>
|True if the database has fields defined.
|-
|<code>field_size</code>
|The number of fields in the database.
|-
|<code>name</code>
|
|-
|<code>size</code>
|The number of records in the database.
|-
|}

Methods

{|class="wikitable sortable"
|-
!Syntax
!Description
|-
|<code>index = add_field(name)</code>
|Returns zero-based index. -1 if the field cannot be added.
|-
|<code>record = add_record()</code>
|
|-
|<code>clear()</code>
|
|-
|<code>delete_field(index <nowiki>|</nowiki> name)</code>
|Delete the field. The values in the associated field in every record in the database will be deleted. This includes those records currently referenced by variables. The index value of the remaining fields will change if those fields have a higher index value than the field being deleted.
|-
|<code>delete_record(index <nowiki>|</nowiki> record)</code>
|
|-
|<code>name = get_field_info(index)</code>
<code>index = get_field_info(name)</code>
|Logs error if index or name does not exist.
|-
|<code>array = get_field_names()</code>
|
|-
|<code>record = get_record(index)</code>
|Logs error if no record exits at the zero-based index.
|-
|<code>record = get_record_by_id(id)</code>
|Get the record based on its unique ID. Retrieved from <code>record.id</code>.
|-
|}

Usage:

/* Create a database and record */
db = application1.get_database("contacts")
db:database.add_field("name")
db:database.add_field("email")
first_rec = db:database.add_record()
first_rec:record.set_field("name", "Joe Bot")
first_rec:record.set_field("email", "jbot@android.com")

/* Loop through all fields in the database */
for (field_index = 0; field_index < db:database.field_size; field_index = field_index + 1)
field_name = db:database.get_field(field_index)
end

/* Loop through all records in a database */
for (index = 0; index < db:database.size; index = index + 1)
rec = db:database.get_record(index)
name = rec:record.get_field("name")
email = rec:record.get_field("email")
for (field_index = 0; field_index < db:database.field_size; field_index = field_index + 1)
field_value = rec:record.get_field(field_index)
end
end

/* Delete the new record and database */
db:database.delete_record(first_rec)
application1.delete_database("contacts")

[[Category:Phonebot]]

@@ Line 6: / Line 6: @@
 * Use the [[Phonebot_developer%27s_reference/Object_reference#Record|Record]] object to manage field values in a record
-Phonebot Plus provides a [[Phonebot_developer%27s_reference/Advanced_tools#Database_browser database browser]] to manage schema and data.
+Phonebot Plus provides a [[Phonebot_developer%27s_reference/Advanced_tools#Database_browser|database browser]] to manage schema and data.
 == Object reference ==

@@ Line 9: / Line 9: @@
 == Object reference ==
 Properties
@@ Line 68: / Line 70: @@
 |}
-Usage:
+=== Record ===
   /* Create a database and record */

@@ Line 5: / Line 5: @@
 * Use the [[Phonebot_developer%27s_reference/Object_reference#Database|Database]] object to manage fields and records in a database
 * Use the [[Phonebot_developer%27s_reference/Object_reference#Record|Record]] object to manage field values in a record
 == Object reference ==

@@ Line 6: / Line 6: @@
 * Use the [[Phonebot_developer%27s_reference/Object_reference#Record|Record]] object to manage field values in a record
-Database object:
+== Object reference ==
 Properties

@@ Line 2: / Line 2: @@
 * Use the [[Phonebot_developer%27s_reference/Object_reference#Application|Application]] object to manage databases in an application
 * Use the [[Phonebot_developer%27s_reference/Object_reference#Database|Database]] object to manage fields and records in a database
 * Use the [[Phonebot_developer%27s_reference/Object_reference#Record|Record]] object to manage field values in a record
 Properties

← Older revision	Revision as of 11:29, 7 August 2012
(No difference)

← Older revision		Revision as of 03:31, 21 June 2012
Line 71:		Line 71:

	=== Record ===		=== Record ===
		+
		+	Represents a record in a specific database.
		+
		+	Properties
		+
		+	{\|class="wikitable sortable"
		+	\|-
		+	!Syntax
		+	!Description
		+	\|-
		+	\|<code>id</code>
		+	\|The unique ID for the record. Read-only.
		+	\|-
		+	\|}
		+
		+	Methods
		+
		+	{\|class="wikitable sortable"
		+	\|-
		+	!Syntax
		+	!Description
		+	\|-
		+	\|<code>field = get_field(index <nowiki>\|</nowiki> name)</code>
		+	\|
		+	\|-
		+	\|<code>array = get_fields()</code>
		+	\|
		+	\|-
		+	\|<code>set_field(index <nowiki>\|</nowiki> name, value)</code>
		+	\|
		+	\|-
		+	\|}

	== Usage ==		== Usage ==

@@ Line 1: / Line 1: @@
 A [[Phonebot]] database is a collection of data accessed by a unique name. Databases map to tables in SQL. Database records are accessed by their zero-based index. Fields within records are accessed by their zero-based index or by their field name.
-* Use [[Phonebot_developer%27s_reference/Object_reference#Application|Application]] to manage databases in an application
+* Use the [[Phonebot_developer%27s_reference/Object_reference#Application|Application]] object to manage databases in an application
-* Use [[Phonebot_developer%27s_reference/Object_reference#Database|Database]] to manage fields and records in a database
+* Use the [[Phonebot_developer%27s_reference/Object_reference#Database|Database]] object to manage fields and records in a database
-* Use [[Phonebot_developer%27s_reference/Object_reference#Record|Record]] to manage field values in a record
+* Use the [[Phonebot_developer%27s_reference/Object_reference#Record|Record]] object to manage field values in a record
 Properties

← Older revision		Revision as of 02:47, 3 May 2012
Line 1:		Line 1:
−		+	A [[Phonebot]] database is a collection of data accessed by a unique name. Databases map to tables in SQL. Database records are accessed by their zero-based index. Fields within records are accessed by their zero-based index or by their field name.
−	A database is a collection of data accessed by a unique name. Databases map to tables in SQL. Database records are accessed by their zero-based index. Fields within records are accessed by their zero-based index or by their field name.

	* Use [[Phonebot_developer%27s_reference/Object_reference#Application\|Application]] to manage databases in an application		* Use [[Phonebot_developer%27s_reference/Object_reference#Application\|Application]] to manage databases in an application