CiviCRM Community Forums (archive)

*

News:

Have a question about CiviCRM?
Get it answered quickly at the new
CiviCRM Stack Exchange Q+A site

This forum was archived on 25 November 2017. Learn more.
How to get involved.
What to do if you think you've found a bug.



  • CiviCRM Community Forums (archive) »
  • Old sections (read-only, deprecated) »
  • Discussion (deprecated) »
  • Documentation, Book and Training Resources (Moderator: Michał Mach) »
  • Database documentation
Pages: [1]

Author Topic: Database documentation  (Read 1324 times)

mirek

  • I’m new here
  • *
  • Posts: 2
  • Karma: 0
  • CiviCRM version: -
  • CMS version: -
  • MySQL version: -
  • PHP version: -
Database documentation
February 13, 2013, 01:40:44 am
Hello,
Is there any place where I can find database documentation? I found ERD but not description for fields :(

xavier

  • Forum Godess / God
  • I’m (like) Lobo ;)
  • *****
  • Posts: 4453
  • Karma: 161
    • Tech To The People
  • CiviCRM version: yes probably
  • CMS version: drupal
Re: Database documentation
February 13, 2013, 02:27:11 am
Hi,

Something that is slightly higher level than the DB, but probably can help is the API doc:

http://drupal.demo.civicrm.org/civicrm/api/doc

Click on the entity (usually entity X is stored into the table civicrm_X)

And as you probably read already: if you hammer directly at the DB level, it's likely your code will have to be upgraded when you change version. Using the api should make it smoother to upgrade with no or little changes.

X+
-Hackathon and data journalism about the European parliament 24-26 jan. Watch out the result

Donald Lobo

  • Administrator
  • I’m (like) Lobo ;)
  • *****
  • Posts: 15963
  • Karma: 470
    • CiviCRM site
  • CiviCRM version: 4.2+
  • CMS version: Drupal 7, Joomla 2.5+
  • MySQL version: 5.5.x
  • PHP version: 5.4.x
Re: Database documentation
February 13, 2013, 06:50:16 am

The sql has got a fair bit of documentation for the fields. So combined with the ERD it makes a relatively decent documentation set

also most of the fields have fairly long names, which we hope are quite descriptive by themselves

if you have any specific questions or see areas that are not clear, let us know and we can potentially work on improving them

lobo
A new CiviCRM Q&A resource needs YOUR help to get started. Visit our StackExchange proposed site, sign up and vote on 5 questions

mirek

  • I’m new here
  • *
  • Posts: 2
  • Karma: 0
  • CiviCRM version: -
  • CMS version: -
  • MySQL version: -
  • PHP version: -
Re: Database documentation
February 13, 2013, 10:36:20 am
Thanks guys. Very helpfull information :)

Pages: [1]
  • CiviCRM Community Forums (archive) »
  • Old sections (read-only, deprecated) »
  • Discussion (deprecated) »
  • Documentation, Book and Training Resources (Moderator: Michał Mach) »
  • Database documentation

This forum was archived on 2017-11-26.