Browse code

- remove avp_url parameter, this was just an alias to db_url, the "standard" - add sentence about avp_table to docs, this must be specified in DB mode

git-svn-id: https://openser.svn.sourceforge.net/svnroot/openser/trunk@5499 689a6050-402a-0410-94f2-e92a70836424

Henning Westerholt authored on 22/01/2009 16:26:13
Showing 3 changed files
... ...
@@ -12,8 +12,8 @@ Ramona-Elena Modroiu
12 12
 
13 13
    Copyright � 2004, 2005 voice-system.ro
14 14
    Revision History
15
-   Revision $Revision$ $Date: 2008-08-06 13:08:33 +0300
16
-                              (Wed, 06 Aug 2008) $
15
+   Revision $Revision$ $Date: 2008-08-06 12:08:33 +0200
16
+                              (Mi, 06 Aug 2008) $
17 17
      __________________________________________________________
18 18
 
19 19
    Table of Contents
... ...
@@ -29,17 +29,16 @@ Ramona-Elena Modroiu
29 29
         1.3. AVP naming format
30 30
         1.4. Exported Parameters
31 31
 
32
-              1.4.1. avp_url (string)
33
-              1.4.2. db_url (string)
34
-              1.4.3. avp_table (string)
35
-              1.4.4. use_domain (integer)
36
-              1.4.5. uuid_column (string)
37
-              1.4.6. username_column (string)
38
-              1.4.7. domain_column (string)
39
-              1.4.8. attribute_column (string)
40
-              1.4.9. value_column (string)
41
-              1.4.10. type_column (string)
42
-              1.4.11. db_scheme (string)
32
+              1.4.1. db_url (string)
33
+              1.4.2. avp_table (string)
34
+              1.4.3. use_domain (integer)
35
+              1.4.4. uuid_column (string)
36
+              1.4.5. username_column (string)
37
+              1.4.6. domain_column (string)
38
+              1.4.7. attribute_column (string)
39
+              1.4.8. value_column (string)
40
+              1.4.9. type_column (string)
41
+              1.4.10. db_scheme (string)
43 42
 
44 43
         1.5. Exported Functions
45 44
 
... ...
@@ -60,7 +59,7 @@ Ramona-Elena Modroiu
60 60
    List of Examples
61 61
 
62 62
    1.1. AVP naming examples
63
-   1.2. Set avp_url parameter
63
+   1.2. Set db_url parameter
64 64
    1.3. Set avp_table parameter
65 65
    1.4. Set use_domain parameter
66 66
    1.5. Set uuid_column parameter
... ...
@@ -158,33 +157,30 @@ ags 1
158 158
 
159 159
 1.4. Exported Parameters
160 160
 
161
-1.4.1. avp_url (string)
161
+1.4.1. db_url (string)
162 162
 
163 163
    DB URL for database connection.
164 164
 
165 165
    This parameter is optional, it's default value being NULL.
166 166
 
167
-   Example 1.2. Set avp_url parameter
167
+   Example 1.2. Set db_url parameter
168 168
 ...
169
-modparam("avpops","avp_url","mysql://user:passwd@host/database")
169
+modparam("avpops","db_url","mysql://user:passwd@host/database")
170 170
 ...
171 171
 
172
-1.4.2. db_url (string)
173
-
174
-   This parameter has the same meaning as "avp_url" parameter.
175
-
176
-1.4.3. avp_table (string)
172
+1.4.2. avp_table (string)
177 173
 
178 174
    DB table to be used.
179 175
 
180
-   This parameter is optional, it's default value being NULL.
176
+   This parameter is optional, it's default value being NULL. But
177
+   if you specify a db_url, you need also setup this parameter.
181 178
 
182 179
    Example 1.3. Set avp_table parameter
183 180
 ...
184 181
 modparam("avpops","avp_table","avptable")
185 182
 ...
186 183
 
187
-1.4.4. use_domain (integer)
184
+1.4.3. use_domain (integer)
188 185
 
189 186
    If the domain part of the an URI should be used for identifying
190 187
    an AVP in DB operations.
... ...
@@ -196,7 +192,7 @@ modparam("avpops","avp_table","avptable")
196 196
 modparam("avpops","use_domain",1)
197 197
 ...
198 198
 
199
-1.4.5. uuid_column (string)
199
+1.4.4. uuid_column (string)
200 200
 
201 201
    Name of column containing the uuid (unique user id).
202 202
 
... ...
@@ -207,7 +203,7 @@ modparam("avpops","use_domain",1)
207 207
 modparam("avpops","uuid_column","uuid")
208 208
 ...
209 209
 
210
-1.4.6. username_column (string)
210
+1.4.5. username_column (string)
211 211
 
212 212
    Name of column containing the username.
213 213
 
... ...
@@ -218,7 +214,7 @@ modparam("avpops","uuid_column","uuid")
218 218
 modparam("avpops","username_column","username")
219 219
 ...
220 220
 
221
-1.4.7. domain_column (string)
221
+1.4.6. domain_column (string)
222 222
 
223 223
    Name of column containing the domain name.
224 224
 
... ...
@@ -229,7 +225,7 @@ modparam("avpops","username_column","username")
229 229
 modparam("avpops","domain_column","domain")
230 230
 ...
231 231
 
232
-1.4.8. attribute_column (string)
232
+1.4.7. attribute_column (string)
233 233
 
234 234
    Name of column containing the attribute name (AVP name).
235 235
 
... ...
@@ -240,7 +236,7 @@ modparam("avpops","domain_column","domain")
240 240
 modparam("avpops","attribute_column","attribute")
241 241
 ...
242 242
 
243
-1.4.9. value_column (string)
243
+1.4.8. value_column (string)
244 244
 
245 245
    Name of column containing the AVP value.
246 246
 
... ...
@@ -251,7 +247,7 @@ modparam("avpops","attribute_column","attribute")
251 251
 modparam("avpops","value_column","value")
252 252
 ...
253 253
 
254
-1.4.10. type_column (string)
254
+1.4.9. type_column (string)
255 255
 
256 256
    Name of integer column containing the AVP type.
257 257
 
... ...
@@ -268,7 +264,7 @@ modparam("avpops","value_column","value")
268 268
 modparam("avpops","type_column","type")
269 269
 ...
270 270
 
271
-1.4.11. db_scheme (string)
271
+1.4.10. db_scheme (string)
272 272
 
273 273
    Definition of a DB scheme to be used for non-standard access to
274 274
    Database information.
... ...
@@ -131,7 +131,6 @@ static cmd_export_t cmds[] = {
131 131
  */
132 132
 static param_export_t params[] = {
133 133
 	{"db_url",            STR_PARAM, &db_url.s        },
134
-	{"avp_url",           STR_PARAM, &db_url.s        },
135 134
 	{"avp_table",         STR_PARAM, &db_table.s      },
136 135
 	{"use_domain",        INT_PARAM, &use_domain      },
137 136
 	{"uuid_column",       STR_PARAM, &uuid_col.s      },
... ...
@@ -128,7 +128,7 @@ $avp(i3:123) - the AVP identified by the integer 123 which has script flags 1
128 128
 	<section>
129 129
 		<title>Exported Parameters</title>
130 130
 		<section>
131
-			<title><varname>avp_url</varname> (string)</title>
131
+			<title><varname>db_url</varname> (string)</title>
132 132
 			<para>
133 133
 			DB URL for database connection.
134 134
 			</para>
... ...
@@ -138,29 +138,23 @@ $avp(i3:123) - the AVP identified by the integer 123 which has script flags 1
138 138
 				</emphasis>
139 139
 			</para>
140 140
 			<example>
141
-				<title>Set <varname>avp_url</varname> parameter</title>
141
+				<title>Set <varname>db_url</varname> parameter</title>
142 142
 				<programlisting format="linespecific">
143 143
 ...
144
-modparam("avpops","avp_url","mysql://user:passwd@host/database")
144
+modparam("avpops","db_url","mysql://user:passwd@host/database")
145 145
 ...
146 146
 				</programlisting>
147 147
 			</example>
148 148
 		</section>
149 149
 		<section>
150
-			<title><varname>db_url</varname> (string)</title>
151
-			<para>
152
-			This parameter has the same meaning as <quote>avp_url</quote>
153
-			parameter.
154
-			</para>
155
-		</section>
156
-		<section>
157 150
 			<title><varname>avp_table</varname> (string)</title>
158 151
 			<para>
159 152
 			DB table to be used.
160 153
 			</para>
161 154
 			<para>
162 155
 				<emphasis>
163
-					This parameter is optional, it's default value being NULL.
156
+					This parameter is optional, it's default value being NULL. But if
157
+					you specify a db_url, you need also setup this parameter.
164 158
 				</emphasis>
165 159
 			</para>
166 160
 			<example>