Summary:ASTERISK-05434: [patch] Documentation about structure of Realtime tables
Reporter:alexb (alexb)Labels:
Date Opened:2005-11-03 03:17:21.000-0600Date Closed:2011-06-07 14:03:22
Versions:Frequency of
Environment:Attachments:( 0) README.extconfig.diff-3.txt
Description:Please update or document properly the _full_ structure of Realtime tables:

(others ?)

From the Wiki and the *.conf.sample files it can't be easily deduced what fields/type/length/default value should be used, for example, for a iax peer rather than a iax user.
The Wiki is also obsolete and/or incomplete.
Comments:By: alexb (alexb) 2005-11-03 03:21:12.000-0600

Sorry, I forgot to put [request] in the summary.

By: Olle Johansson (oej) 2005-11-03 03:24:08.000-0600

Please provide a patch to README.extconfig . Thank you for contributing to Asterisk!

By: alexb (alexb) 2005-11-03 04:29:29.000-0600

The attached file is a first attempt to include tables structure in the README.extconfig. It will need to be heavily revised!
My main difficulty however is distinguishing between IAX users and peers fields, so I can't help much here. I'll add SIP users/peers tables structure in next few hours, I'm working on it.
Please also note that content of the patch comes mainly from the Wiki and that I only slightly modified it, so I don't think I have to include or send any disclaimer for it.

By: alexb (alexb) 2005-11-03 05:40:08.000-0600

diff-2.txt includes now separate tables for SIP peers and users.
Oej, please have a look at it, since some fields are not documented at all even in sip.conf.sample (e.g. promiscredir). Hints about fields allowed values are also welcome.

It's not much but I'm doing my best.

By: alexb (alexb) 2005-11-03 05:49:42.000-0600

Uploaded diff-3.txt because of a typo in a field name.
Please delete previous files. Thanks!

By: Olle Johansson (oej) 2005-11-03 07:10:43.000-0600

You can document that you don't need all fields that is available in the configuration. If you do not use "defaultip" you don't have to have it in the database table.

By: Jason Parker (jparker) 2005-11-03 09:58:43.000-0600

int(5) on mailbox in voicemail_users will not allow 10 digit extensions.

I just ran into this problem yesterday.  Changing it to a varchar worked fine.

edit: This was on mysql.

By: alexb (alexb) 2005-11-03 11:31:19.000-0600

north, I'll change the mailbox field type in next revision. Thanks for your hint.

oej, ok, I'll add in the text that not all fields are needed. However I think that the table structure should be _always_ the mirror of the complete entity structure, and this is why I asked (and now collecting by myself) this documentation (BTW, we're developing a new GUI which heavily uses Realtime and that will be released soon as an Open Source Project). I think that unused fields for an entity should be NULL and therefore ignored by Realtime when creating the entity. I believe this is the current behaviour, isn't it?

As a side note, the only possibility to know what fields are available for iax peers/users is "parsing" the samples or even the code: unfortunately, there isn't any list like in sip.conf. Could anyone help me with iax, please?

By: Kevin P. Fleming (kpfleming) 2005-12-01 17:25:30.000-0600

Can we get an update here?

By: Tilghman Lesher (tilghman) 2005-12-26 23:46:46.000-0600

This is a great documentation update; please don't give up now.  We need your newest patch uploaded.

By: Jason Parker (jparker) 2005-12-27 01:06:00.000-0600

AlexB, do you have a disclaimer on file with Digium?  If you don't have time, I can try to take this over, but if this patch isn't disclaimed, I would have to start from scratch.

By: alexb (alexb) 2005-12-27 07:08:44.000-0600

Hi guys, it's not my intention to give up, but... nobody has helped me with IAX, so I thought nobody was really interested.

I know that there has been lots of changes/improvements so far. In the meanwhile we've released our open source GUI, based on ARA, and its success makes me quite busy. However, next week I'll give a look to this issue again.

As regards the disclaimer, I don't think this contribution is so relevant that really needs one. :) Most of the "patch" comes from Wiki (I wrote it in my previous post), but if you think it's required I'll send it anyway. :)

By: Olle Johansson (oej) 2006-01-09 14:12:19.000-0600

Please confirm your disclaimer - it makes it easier to process. We're anxiously waiting for updates.

Thank you!


By: Tilghman Lesher (tilghman) 2006-03-01 16:07:01.000-0600

Reporter seems to have lost interest.