Changes

Jump to: navigation, search

Using database API

36 bytes added, 13:26, 1 March 2007
fix api links
[[Category:Developers/Tutorials]]
==Introduction==
This document describes the basics of the 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. 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 [http://gramps-project.org/index.php?module=pagemaster&PAGE_user_op=view_page&PAGE_id=7 GRAMPS documentation web page]. Separate [http://developerswww.gramps-project.org/devdoc/api/2.2/ API Reference Documentation] is 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].
==Primary Objects==
Primary objects are the fundamental objects in the GRAMPS database. These objects are:
* [http://developerswww.gramps-project.org/devdoc/api/public2.2/private/RelLib._Person.Person-class.html Person] - Contains the information specific to an individual person.* [http://developerswww.gramps-project.org/devdoc/api/public2.2/private/RelLib._Family.Family-class.html Family] - Contains the information specific to relationships between people. This typically contains one or two parents and zero or more children.* [http://developerswww.gramps-project.org/devdoc/api/public2.2/private/RelLib._Source.Source-class.html Source] - Contains the information related to a source of information.* [http://developerswww.gramps-project.org/devdoc/api/public2.2/private/RelLib._Place.Place-class.html Place] - Contains the information related to a specific place.* [http://developerswww.gramps-project.org/devdoc/api/public2.2/private/RelLib._MediaObject.MediaObject-class.html Media Object] - Contains the information related to a media object. This includes images, documents, or any other type of related files.* [http://developerswww.gramps-project.org/devdoc/api/public2.2/private/RelLib._Event.Event-class.html Event] - Contains the information related to an event. The event is treated as a primary object in the database, it currently does not appear as a primary object to the end user.
Primary objects are treated as tables within the database. Individual components that compose the primary object are stored as individual items in the database.
35
edits

Navigation menu