doc/database.html
author Sandro Knauß <knauss@netzguerilla.net>
Wed, 25 Apr 2012 00:04:47 +0200
branchdevel
changeset 274 1653470ccaff
parent 271 b218238e76b9
permissions -rw-r--r--
doc: adding sipgate documentation writing a new provider
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
77
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     2
<html>
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     3
	
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     4
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     5
	<head>
271
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 77
diff changeset
     6
		<title>Iro ·  Datenbase</title>
77
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     7
		<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     8
		<meta charset="utf-8">
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     9
		<meta name="description" content="">
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    10
		<meta name="keywords" content="">
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    11
		<link rel="shortcut icon" type="image/x-icon" href="images/favicon.png">
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    12
		<link rel="stylesheet" href="css/reset.css" type="text/css" media="screen">
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    13
		<link rel="stylesheet" href="css/960.css" type="text/css" media="screen">
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    14
		<link rel="stylesheet" href="css/style.css" type="text/css" media="screen">
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    15
		<!--[if IE]><link rel="stylesheet" href="css/style-ie.css" type="text/css"  media="screen" /><![endif] -->
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    16
	</head>
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    17
	<body>
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    18
	<div id="head-container">
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    19
		<div id="head">
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    20
			<h1 id="logo"><a href="index.html" class="logo" title="Netzguerilla"><span>Netzguerilla</span></a></h1>
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    21
			<ul id="menu">
271
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 77
diff changeset
    22
				<li><a href="index.html" class="menu">Iro</a></li><li><a href="current.html" class="menu">API Documentation</a></li><li><a href="database.html" class="menu active">Datenbase Schema</a></li><li><a href="about.html" class="menu">About us</a></li>
77
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    23
			</ul>
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    24
		</div>
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    25
	</div>
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    26
	<div id="content-container">
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    27
		<div id="content" class="container_12">
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    28
			<div id="main" class="grid_9">
271
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 77
diff changeset
    29
				<h2>Datenbase Schema</h2>
77
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    30
				<div class="item">
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    31
			<p>
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    32
			</p>
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    33
			<ol>
271
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 77
diff changeset
    34
				<li value="1">1. <a href="#schema">Datenbase schema</a></li>
77
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    35
				<li value="3">3.
271
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 77
diff changeset
    36
					<a href="#tables">Tables</a>
77
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    37
					<ol>
271
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 77
diff changeset
    38
						<li value="2.1">2.1 <a href="#table-apiuser">Apiuser</a></li><li value="2.2">2.2 <a href="#table-offer">Offer</a></li><li value="2.3">2.3 <a href="#table-job">Job</a></li><li value="2.4">2.4 <a href="#table-userright">Userright</a></li><li value="2.5">2.5 <a href="#table-message">Message</a></li>
77
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    39
					</ol>
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    40
				</li>
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    41
			</ol>
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    42
		</div><div class="item" id="schema">
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    43
			<h3>Schema</h3>
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    44
			<img src="images/db-schema.svg">
271
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 77
diff changeset
    45
			<p>Overview of used tables.</p>
77
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    46
		</div><div class="item" id="tables">
271
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 77
diff changeset
    47
			<h3>Tables</h3>
77
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    48
			<div class="item" id="table-apiuser">
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    49
				<h4>Apiuser</h4>
271
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 77
diff changeset
    50
				<p><p>An user in iro.</p></p>
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 77
diff changeset
    51
			</div><div class="item" id="table-offer">
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 77
diff changeset
    52
				<h4>Offer</h4>
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 77
diff changeset
    53
				<p><p>All possible Offers over a Message can be sended. <strong>provider</strong>, <strong>typ</strong> and <strong>route</strong> are used to get the data form configuration file.</p></p>
77
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    54
			</div><div class="item" id="table-job">
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    55
				<h4>Job</h4>
271
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 77
diff changeset
    56
				<p><p>A complete Job.</p>
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 77
diff changeset
    57
<blockquote>
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 77
diff changeset
    58
<ul class="simple">
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 77
diff changeset
    59
<li><strong>status</strong> show the status of the job (<tt class="docutils literal">init</tt>, <tt class="docutils literal">started</tt>, <tt class="docutils literal">sending</tt>, <tt class="docutils literal">sended</tt> or <tt class="docutils literal">error</tt>).</li>
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 77
diff changeset
    60
<li><strong>info</strong> is used to make it possible to create different billing groups for user.</li>
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 77
diff changeset
    61
</ul>
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 77
diff changeset
    62
</blockquote></p>
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 77
diff changeset
    63
			</div><div class="item" id="table-userright">
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 77
diff changeset
    64
				<h4>Userright</h4>
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 77
diff changeset
    65
				<p><p>Allowed offers for one user. Default routes are sorted by <strong>default</strong> value.</p></p>
77
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    66
			</div><div class="item" id="table-message">
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    67
				<h4>Message</h4>
271
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 77
diff changeset
    68
				<p><p>A message that has created costs.</p>
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 77
diff changeset
    69
<blockquote>
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 77
diff changeset
    70
<strong>isBilled</strong> is False since the bill is paid.</blockquote></p>
77
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    71
			</div>
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    72
		</div>
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    73
			</div>
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    74
			<div class="clear"></div>
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    75
		</div>
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    76
	</div>
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    77
	<div id="foot-container">
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    78
		<div id="foot">
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    79
			<p>© 2010-2011 <a href="impressum.html">Netzguerilla.net</a>.</p>
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    80
		</div>
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    81
	</div>
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    82
	</body>
7dce6c0f06fb adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    83
</html>