doc/help/ch13.xml

   1 <chapter xml:id="ch13">
   2         <title>Приложение Г</title>
   3         <simplesect>
   4         <title>Описание процесса установки БД для СУБД MySQL</title>
   5         <para>Для работы модуля необходимо завести учетную запись пользователя СУБД MySQL. Для этого можно использовать командный интерпретатор mysql:</para>
   6 <programlisting linenumbering="unnumbered">
   7 $ mysql -u root -p
   8 Enter password:
   9 Welcome to the MySQL monitor.  Commands end with ; or \g.
  10 Your MySQL connection id is 9 to server version: 5.0.26-log
  11
  12 Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
  13
  14 mysql&gt; create user stg_user identified by '123456';
  15 Query OK, 0 rows affected (0.04 sec)
  16 </programlisting>
  17         <para>Модуль для работы с MySQL автоматически создает БД и необходимые для его работы таблицы. Для этого у пользователя, указанного в настройках должны быть установлены соответствующие права (см. документацию по настройке MySQL: MySQL User Account Management). Модуль может корректно работать и с пользователем с ограниченными правами (полный доступ только к своей БД). Для этого необходимо сперва вручную создать БД, а затем дать пользователю права на доступ к ней. Например так:</para>
  18 <programlisting linenumbering="unnumbered">
  19 $ mysql -u root -p
  20 Enter password:
  21 Welcome to the MySQL monitor.  Commands end with ; or \g.
  22 Your MySQL connection id is 9 to server version: 5.0.26-log
  23
  24 Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
  25
  26 mysql&gt; create user stg_user identified by '123456';
  27 Query OK, 0 rows affected (0.04 sec)
  28
  29 mysql&gt; create database stg_database;
  30 Query OK, 1 row affected (0.02 sec)
  31
  32 mysql&gt; grant all on stg_database.* to stg_user;
  33 Query OK, 0 rows affected (0.06 sec)
  34 </programlisting>
  35         <para>После этого модуль при первом запуске сам создаст необходимые таблицы.</para>
  36         </simplesect>
  37         <simplesect>
  38         <title>Описание структуры БД для СУБД MySQL</title>
  39         <para>Таблица admins (учетные записи администраторов системы):</para>
  40         <itemizedlist mark="opencircle">
  41                 <listitem><para>login – название учетной записи администратора системы;</para></listitem>
  42                 <listitem><para>password – пароль для учетной записи администратора системы;</para></listitem>
  43                 <listitem><para>ChgConf – флаг, разрешающий менять конфигурационные параметры пользователы;</para></listitem>
  44                 <listitem><para>ChgPassword – флаг, позволяющий менять пароль пользователя;</para></listitem>
  45                 <listitem><para>ChgStat – флаг, позволяющий менять статистические данные пользователя;</para></listitem>
  46                 <listitem><para>ChgCash – флаг, позволяющий менять количество денег на счету у пользователя;</para></listitem>
  47                 <listitem><para>UsrAddDel – флаг, позволяющий управлять учетными записями пользователей;</para></listitem>
  48                 <listitem><para>ChgTariff – флаг, позволяющий управлять тарифами;</para></listitem>
  49                 <listitem><para>ChgAdmin – флаг, позволяющий управлять учетными записями администраторов системы.</para></listitem>
  50         </itemizedlist>
  51         <para>Таблица tariffs (описание тарифов системы):</para>
  52         <itemizedlist mark="opencircle">
  53                 <listitem><para>name – название тарифа;</para></listitem>
  54                 <listitem><para>PriceDayA&lt;n&gt; - стоимость 1 Мб трафика по направлению &lt;n&gt; днем до превышения порога;</para></listitem>
  55                 <listitem><para>PriceDayB&lt;n&gt; - стоимость 1 Мб трафика по направлению &lt;n&gt; днем после превышения порога;</para></listitem>
  56                 <listitem><para>PriceNightA&lt;n&gt; - стоимость 1 Мб трафика по направлению &lt;n&gt; ночью до превышения порога;</para></listitem>
  57                 <listitem><para>PriceNightB&lt;n&gt; - стоимость 1 Мб трафика по направлению &lt;n&gt; ночью после превышения порога;</para></listitem>
  58                 <listitem><para>Threshold&lt;n&gt; - порог по трафику;</para></listitem>
  59                 <listitem><para>Time&lt;n&gt; - время дня;</para></listitem>
  60                 <listitem><para>NoDiscount&lt;n&gt; - флаг, указывающий, что трафик по направлению &lt;n&gt; считается без учета порогового значения;</para></listitem>
  61                 <listitem><para>SinglePrice&lt;n&gt; - флаг, указывающий, что трафик по направлению &lt;n&gt; считается без учета времени суток;</para></listitem>
  62                 <listitem><para>PassiveCost – стоимость «заморозки» учетной записи пользователя;</para></listitem>
  63                 <listitem><para>Fee – абонплата;</para></listitem>
  64                 <listitem><para>Free – количество бесплатных Мб трафика, входящих в абонплату;</para></listitem>
  65                 <listitem><para>TraffType — тип тарификации трафика:</para>
  66                         <itemizedlist mark="square">
  67                                 <listitem><para>up+down — входящий и исходящий трафик тарифицируется суммарно;</para></listitem>
  68                                 <listitem><para>up — тарифицируется только исходящий трафик;</para></listitem>
  69                                 <listitem><para>down — тарифицируется только входящий трафик;</para></listitem>
  70                                 <listitem><para>max — тарифицируется большее количество трафика;</para></listitem>
  71                         </itemizedlist>
  72                 </listitem>
  73                 <listitem><para>Period — тип абонплаты:</para>
  74                         <itemizedlist mark="square">
  75                                 <listitem><para>day — ежедневная абонплата (параметр Fee трактуется как значение списываемое ежедневно);</para></listitem>
  76                                 <listitem><para>month — ежемесячная абонплата (классическая, параметр Fee трактуется как значение списываемое за месяц, в том числе в режиме SpreadFee);</para></listitem>
  77                         </itemizedlist>
  78                 </listitem>
  79                 <listitem><para>ChangePolicy — политика смены тарифа:</para>
  80                         <itemizedlist mark="square">
  81                                 <listitem><para>allow — на период действия политики смена тарифного плана разрешена;</para></listitem>
  82                                 <listitem><para>to_cheap — на период действия политики разрешена смена тарифного плана на более дешевый;</para></listitem>
  83                                 <listitem><para>to_expensive — на период действия политики разрешена смена тарифного плана на более дорогой;</para></listitem>
  84                                 <listitem><para>deny — на период действия политики смена тарифного плана запрещена;</para></listitem>
  85                         </itemizedlist>
  86                 </listitem>
  87                 <listitem><para>ChangePolicyTimeout — момент завершения действия политики тарификации (0 - политика тарификации не завершается никогда);</para></listitem>
  88         </itemizedlist>
  89         <para>Таблица users (учетные записи пользователей системы и их статистика):</para>
  90         <itemizedlist mark="opencircle">
  91                 <listitem><para>login – название учетной записи пользователя;</para></listitem>
  92                 <listitem><para>Password – пароль для учетной записи пользователя;</para></listitem>
  93                 <listitem><para>Passive – флаг режима «Заморожен»;</para></listitem>
  94                 <listitem><para>Down – флаг режима «Отключен»;</para></listitem>
  95                 <listitem><para>AlwaysOnline – флаг режима «Всегда on-line»;</para></listitem>
  96                 <listitem><para>Tariff – название тарифа;</para></listitem>
  97                 <listitem><para>Address – адрес пользователя;</para></listitem>
  98                 <listitem><para>Phone – номер телефона пользователя;</para></listitem>
  99                 <listitem><para>Email – адрес электронной почты пользователя;</para></listitem>
 100                 <listitem><para>Note – примечания;</para></listitem>
 101                 <listitem><para>RealName – реальное имя пользователя;</para></listitem>
 102                 <listitem><para>StgGroup – название группы пользователя;</para></listitem>
 103                 <listitem><para>Credit – величина кредита в деньгах;</para></listitem>
 104                 <listitem><para>TariffChange – название тарифа, на который будет переведен пользователь в начале месяца;</para></listitem>
 105                 <listitem><para>Userdata&lt;n&gt; - поля дополнительных данных пользователя;</para></listitem>
 106                 <listitem><para>CreditExpire – дата окончания действия кредита пользователя;</para></listitem>
 107                 <listitem><para>DisabledDetailStat — отключение детальной статистики пользователя;</para></listitem>
 108                 <listitem><para>IP – список IP-адресов пользователя;</para></listitem>
 109                 <listitem><para>D&lt;n&gt; - объем входящего трафика по направлению &lt;n&gt;;</para></listitem>
 110                 <listitem><para>U&lt;n&gt; - объем исходящего трафика по направлению &lt;n&gt;;</para></listitem>
 111                 <listitem><para>Cash – количество денег на счету;</para></listitem>
 112                 <listitem><para>FreeMb – количество бесплатных мегабайт;</para></listitem>
 113                 <listitem><para>LastCashAdd – последнее пополнение счета;</para></listitem>
 114                 <listitem><para>LastCashAddTime – время последнего пополнения счета;</para></listitem>
 115                 <listitem><para>PassiveTime - время, проведенное пользователем в «замороженном» состоянии за месяц (используется для вычисления объема снимаемой абонплаты);</para></listitem>
 116                 <listitem><para>LastActivityTime – время последней активности пользователя;</para></listitem>
 117                 <listitem><para>NAS – используется совместно с модулем захвата трафика для NetFlow.</para></listitem>
 118         </itemizedlist>
 119         <para>Таблица messages (сообщения пользователю):</para>
 120         <itemizedlist mark="opencircle">
 121                 <listitem><para>login – название учетной записи пользователя, для которой предназначено сообщение;</para></listitem>
 122                 <listitem><para>id – уникальный иденетификатор сообщения;</para></listitem>
 123                 <listitem><para>type – тип сообщения;</para></listitem>
 124                 <listitem><para>lastSendTime – время последней отсылки сообщения;</para></listitem>
 125                 <listitem><para>creationTime – время создания сообщения;</para></listitem>
 126                 <listitem><para>showTime – время показа сообщения;</para></listitem>
 127                 <listitem><para>stgRepeat – количество повторений сообщения;</para></listitem>
 128                 <listitem><para>repeatPeriod – период повторения сообщения;</para></listitem>
 129                 <listitem><para>text – текст сообщения.</para></listitem>
 130         </itemizedlist>
 131         <para>Таблица stat (месячная статистика пользователей):</para>
 132         <itemizedlist mark="opencircle">
 133                 <listitem><para>login – название учетной записи пользователя, которой принадлежит запись в статистике;</para></listitem>
 134                 <listitem><para>month – месяц записи статистики;</para></listitem>
 135                 <listitem><para>year – год записи статистики;</para></listitem>
 136                 <listitem><para>U&lt;n&gt; - объем исходящего трафика за месяц по направлениям;</para></listitem>
 137                 <listitem><para>D&lt;n&gt; - объем входящего трафика за месяц по направлениям;</para></listitem>
 138                 <listitem><para>cash – количество денег на счету.</para></listitem>
 139         </itemizedlist>
 140         <para>Таблица logs_&lt;m&gt;_&lt;y&gt; (помесячный журнал сессий пользователя и изменений его параметров):</para>
 141         <itemizedlist mark="opencircle">
 142                 <listitem><para>unid – уникальный идентификатор записи;</para></listitem>
 143                 <listitem><para>login – название учетной записи пользователя;</para></listitem>
 144                 <listitem><para>text – текст записи в журнале.</para></listitem>
 145         </itemizedlist>
 146         <para>Таблица detailstat_&lt;m&gt;_&lt;y&gt; (помесячная детальная статистика пользователей):</para>
 147         <itemizedlist mark="opencircle">
 148                 <listitem><para>login – название учетной записи пользователя;</para></listitem>
 149                 <listitem><para>day – порядковый номер дня в месяце;</para></listitem>
 150                 <listitem><para>startTime – время начала сессии;</para></listitem>
 151                 <listitem><para>endTime – время завершения сессии;</para></listitem>
 152                 <listitem><para>IP – удаленный IP-адрес;</para></listitem>
 153                 <listitem><para>dir – направление;</para></listitem>
 154                 <listitem><para>up – объем исходящего трафика;</para></listitem>
 155                 <listitem><para>down – объем входящего трафика;</para></listitem>
 156                 <listitem><para>cash – стоимость трафика.</para></listitem>
 157         </itemizedlist>
 158         </simplesect>
 159 </chapter>