Using database API - Revision history

Patsyblefebre: Gramps

2013-02-04T06:02:45Z

Gramps

Patsyblefebre: Gramps

2013-01-28T00:58:26Z

Gramps

Patsyblefebre: Gramps

2013-01-20T06:31:40Z

Gramps

Patsyblefebre: /* Database API */ update all 404ed links

2012-12-27T05:20:55Z

‎Database API: update all 404ed links

Romjerome: /* 6. Citation: */

2012-09-05T19:40:18Z

‎6. Citation:

Romjerome: /* 6. Citation: */

2012-09-05T19:39:41Z

‎6. Citation:

Romjerome: /* 5. Source Reference */

2012-09-05T19:38:54Z

‎5. Source Reference

Romjerome: /* Primary Objects */

2012-09-05T19:37:39Z

‎Primary Objects

Romjerome at 17:05, 3 March 2012

2012-03-03T17:05:07Z

Romjerome at 15:37, 18 February 2012

2012-02-18T15:37:17Z

@@ Line 260: / Line 260: @@
 ==Database Objects==
-GRAMPS provides a standard interface for all database objects. The GRAMPS database object provides the interface to the lower level database. Currently, only one database interface is supported:
+Gramps provides a standard interface for all database objects. The Gramps database object provides the interface to the lower level database. Currently, only one database interface is supported:
 * GrampsBSDDB - the default database, providing access to a Berkeley DB database.
@@ Line 304: / Line 304: @@
 ===Iterating through the database===
-Frequently, it is useful to iterate through all the elements of a database. GRAMPS provides two ways of accomplishing this. The first method involves getting a list of all the handles and looping over the list. This method is the easiest to implement. An example is below:
+Frequently, it is useful to iterate through all the elements of a database. Gramps provides two ways of accomplishing this. The first method involves getting a list of all the handles and looping over the list. This method is the easiest to implement. An example is below:
     for handle in database.get_person_handles():
        person = database.get_person_from_handle(handle)

@@ Line 34: / Line 34: @@
 The DbDjango interface defines the Gramps data in terms of ''models'' and ''relations'' from the [http://www.djangoproject.com/ Django project]. The database backend can be any implementation that supports Django, including such popular SQL implementations as sqlite, MySQL, Postgresql, and Oracle. The data is retrieved from the SQL fields, serialized and then unserialized into the primary data types (below).
-For more details on the Gramps Django project, see [[GEPS 013: GRAMPS Webapp]].
+For more details on the Gramps Django project, see [[GEPS 013: Gramps Webapp]].
 === Using the Database ===

@@ Line 1: / Line 1: @@
-{{man warn|If you are a looking for documentation on how to use the GRAMPS system as a user instead of as a program developer, it can be found on the [[Portal:Using_GRAMPS|GRAMPS documentation web page]].}}
+{{man warn|If you are a looking for documentation on how to use the Gramps system as a user instead of as a program developer, it can be found on the [[Portal:Using_Gramps|Gramps documentation web page]].}}
-Explanation of the basics, underlying GRAMPS database. This is not intended to be a reference manual, but an introductory programmer's guide to using the GRAMPS database access routines.
+Explanation of the basics, underlying Gramps database. This is not intended to be a reference manual, but an introductory programmer's guide to using the Gramps database access routines.
-Separate [http://www.gramps-project.org/docs/ API Reference Documentation for version 3.3.0 of GRAMPS] and simple [[Media:API.svg|UML (svg) for 3.4.x]] are available.
+Separate [http://www.gramps-project.org/docs/ API Reference Documentation for version 3.3.0 of Gramps] and simple [[Media:API.svg|UML (svg) for 3.4.x]] are available.
-GRAMPS is written in the [http://www.python.org Python] language. A basic familiarity with Python is required before the database objects can be effectively used. If you are new to Python, you may wish to check out the [http://docs.python.org/tut/tut.html Python tutorial].
+Gramps is written in the [http://www.python.org Python] language. A basic familiarity with Python is required before the database objects can be effectively used. If you are new to Python, you may wish to check out the [http://docs.python.org/tut/tut.html Python tutorial].
 == Database API ==
@@ Line 45: / Line 45: @@
 ==Primary Objects==
-Primary objects are the fundamental objects in the GRAMPS database. These objects are:
+Primary objects are the fundamental objects in the Gramps database. These objects are:
 * [http://www.gramps-project.org/docs/gen/gen_lib.html#module-gen.lib.person Person] - Contains the information specific to an individual person.
 * [http://www.gramps-project.org/docs/gen/gen_lib.html#module-gen.lib.family Family] - Contains the information specific to relationships between people. This typically contains one or two parents and zero or more children.
@@ Line 338: / Line 338: @@
 ===Getting notification of changes to the database===
-If you have widgets that are displaying the content of the database tables you need to be aware that the database can change. Records may be added, removed or updated by other parts of GRAMPS and your widget must show these changes. The GRAMPS database provides a signalling mechanism that can be used to notify your widget of changes to the database. The documentation for the ((GrampsDBCallback)) class provides a description of the signalling  mechanism. For most code that uses the GRAMPS database all that is required is for callback functions to be connected to the correct signals. For example:
+If you have widgets that are displaying the content of the database tables you need to be aware that the database can change. Records may be added, removed or updated by other parts of Gramps and your widget must show these changes. The Gramps database provides a signalling mechanism that can be used to notify your widget of changes to the database. The documentation for the ((GrampsDBCallback)) class provides a description of the signalling  mechanism. For most code that uses the Gramps database all that is required is for callback functions to be connected to the correct signals. For example:
     database.connect('person-add',self.update_view)
     database.connect('person-update',self.update_view)

@@ Line 15: / Line 15: @@
 The full database hierarchy is:
-* '''DbBsddb''' - read and write implementation to BSDDB databases ([http://gramps.svn.sourceforge.net/viewvc/gramps/trunk/src/gen/db/write.py?view=markup gen/db/write.py])
+* '''DbBsddb''' - read and write implementation to BSDDB databases ([http://svn.code.sf.net/p/gramps/code/trunk/gramps/gen/db/write.py gen/db/write.py])
-** '''DbWriteBase''' - virtual and implementation-independent methods for reading data ([http://gramps.svn.sourceforge.net/viewvc/gramps/trunk/src/gen/db/base.py?view=markup gen/db/base.py])
+** '''DbWriteBase''' - virtual and implementation-independent methods for reading data ([http://svn.code.sf.net/p/gramps/code/trunk/gramps/gen/db/base.py gen/db/base.py])
-** '''DbBsddbRead''' - read-only (accessors, getters) implementation to BSDDB databases ([http://gramps.svn.sourceforge.net/viewvc/gramps/trunk/src/gen/db/read.py?view=markup gen/db/read.py])
+** '''DbBsddbRead''' - read-only (accessors, getters) implementation to BSDDB databases ([http://svn.code.sf.net/p/gramps/code/trunk/gramps/gen/db/read.py gen/db/read.py])
-*** '''DbReadBase''' - virtual and implementation-independent methods for reading data ([http://gramps.svn.sourceforge.net/viewvc/gramps/trunk/src/gen/db/base.py?view=markup gen/db/base.py])
+*** '''DbReadBase''' - virtual and implementation-independent methods for reading data ([http://svn.code.sf.net/p/gramps/code/trunk/gramps/gen/db/base.py gen/db/base.py])
-*** '''Callback''' - callback and signal functions ([http://gramps.svn.sourceforge.net/viewvc/gramps/trunk/src/gen/utils/callback.py?view=markup gen/utils/callback.py])
+*** '''Callback''' - callback and signal functions ([http://svn.code.sf.net/p/gramps/code/trunk/gramps/gen/utils/callback.py gen/utils/callback.py])
-** '''UpdateCallback''' - callback functionality ([http://gramps.svn.sourceforge.net/viewvc/gramps/trunk/src/gen/db/read.py?view=markup gen/updatecallback.py])
+** '''UpdateCallback''' - callback functionality ([http://svn.code.sf.net/p/gramps/code/trunk/gramps/gen/updatecallback.py gen/updatecallback.py])
-** '''DbTxn''' - class for managing Gramps transactions and the undo database ([http://gramps.svn.sourceforge.net/viewvc/gramps/trunk/src/gen/db/txn.py??view=markup gen/bd/txn.py])
+** '''DbTxn''' - class for managing Gramps transactions and the undo database ([http://svn.code.sf.net/p/gramps/code/trunk/gramps/gen/db/txn.py gen/db/txn.py])
-* '''DbDjango''' - read and write implementation to Django-based databases ([http://gramps.svn.sourceforge.net/viewvc/gramps/trunk/src/web/dbdjango.py?view=markup web/dbdjango.py])
+* '''DbDjango''' - read and write implementation to Django-based databases ([http://svn.code.sf.net/p/gramps/code/trunk/gramps/webapp/dbdjango.py webapp/dbdjango.py])
-** '''DbWriteBase''' - virtual and implementation-independent methods for reading data ([http://gramps.svn.sourceforge.net/viewvc/gramps/trunk/src/gen/db/base.py?view=markup gen/db/base.py])
+** '''DbWriteBase''' - virtual and implementation-independent methods for reading data ([http://svn.code.sf.net/p/gramps/code/trunk/gramps/gen/db/base.py gen/db/base.py])
-** '''DbReadBase''' - virtual and implementation-independent methods for reading data ([http://gramps.svn.sourceforge.net/viewvc/gramps/trunk/src/gen/db/base.py?view=markup gen/db/base.py])
+** '''DbReadBase''' - virtual and implementation-independent methods for reading data ([http://svn.code.sf.net/p/gramps/code/trunk/gramps/gen/db/base.py gen/db/base.py])
 === DbBsddb ===

@@ Line 147: / Line 147: @@
 # gramps_id
 # date
 # confidence
 # volume
@@ Line 153: / Line 152: @@
 # note_list
 # media_list
 ===7. Media:===

@@ Line 224: / Line 224: @@
 # status
 # private
 ==Handles==

@@ Line 51: / Line 51: @@
 * [http://www.gramps-project.org/docs/gen/gen_lib.html#module-gen.lib.place Place] - Contains the information related to a specific place.
 * [http://www.gramps-project.org/docs/gen/gen_lib.html#module-gen.lib.src Source] - Contains the information related to a source of information.
 * [http://www.gramps-project.org/docs/gen/gen_lib.html#module-gen.lib.mediaobj Media Object] - Contains the information related to a media object. This includes images, documents, or any other type of related files.
 * [http://www.gramps-project.org/docs/gen/gen_lib.html#module-gen.lib.repo Repository] - Contains the information related to a repository.
@@ Line 142: / Line 143: @@
 # private
-===6. Media:===
+===6. Citation:===
 # handle
 # gramps_id
@@ Line 156: / Line 162: @@
 # private
-===7. Repository===
+===8. Repository===
 # handle
 # gramps_id
@@ Line 166: / Line 172: @@
 # private
-===8. Note===
+===9. Note===
 # handle
 # gramps_id

← Older revision		Revision as of 17:05, 3 March 2012
Line 342:		Line 342:
	[[Category:Developers/Tutorials]]		[[Category:Developers/Tutorials]]
	[[Category:Developers/General]]		[[Category:Developers/General]]
		+	[[Category:Reports\|A]]
		+	[[Category:Plugins\|A]]
		+	[[Category:Tools\|A]]
		+	[[Category:Gramplets\|A]]
		+	[[Category:Views\|A]]