Plugin:MirLua/ru/m database: Difference between revisions

From Miranda NG
< MirLua‎ | MirLua
Jump to navigation Jump to search
(→‎AllSettings: trailing spaces clean up)
(double pipes)
Line 20: Line 20:
: Возвращает номер контакта. Список оканчивается элементом со значением '''nil'''
: Возвращает номер контакта. Список оканчивается элементом со значением '''nil'''
;Пример
;Пример
{{Content:MirLua/Example||code=
{{Content:MirLua/Example|code=
for hContact in db.AllContacts('JABBER_1') do
for hContact in db.AllContacts('JABBER_1') do
   print(db.GetSetting(hContact, 'JABBER_1', 'Nick'))
   print(db.GetSetting(hContact, 'JABBER_1', 'Nick'))
Line 38: Line 38:
: Возвращает количество событий
: Возвращает количество событий
;Пример
;Пример
{{Content:MirLua/Example||code=db.GetEventCount(hContact)}}
{{Content:MirLua/Example|code=db.GetEventCount(hContact)}}


=== AllEvents ===
=== AllEvents ===
Line 50: Line 50:
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''
;Пример
;Пример
{{Content:MirLua/Example||code=for hEvent in db.AllEvents(hContact) do
{{Content:MirLua/Example|code=for hEvent in db.AllEvents(hContact) do
   local event = totable(hEvent, "DBEVENTINFO")
   local event = totable(hEvent, "DBEVENTINFO")
   print(event.Timestamp, event.Blob)
   print(event.Timestamp, event.Blob)
Line 66: Line 66:
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''
: Возвращает номер события. Список оканчивается элементом со значением '''nil'''
;Пример
;Пример
{{Content:MirLua/Example||code=
{{Content:MirLua/Example|code=
for hEvent in db.AllEventsFromEnd(hContact) do
for hEvent in db.AllEventsFromEnd(hContact) do
   local event = totable(hEvent, "DBEVENTINFO")
   local event = totable(hEvent, "DBEVENTINFO")
Line 94: Line 94:
: Возвращает значение настройки или значание по умолчаниию или '''nil'''
: Возвращает значение настройки или значание по умолчаниию или '''nil'''
;Пример
;Пример
{{Content:MirLua/Example||code=db.GetSetting(nil, 'test', 'some')}}
{{Content:MirLua/Example|code=db.GetSetting(nil, 'test', 'some')}}


=== AllSettings ===
=== AllSettings ===
Line 109: Line 109:
: Возвращает имя секции. Список оканчивается элементом со значением '''nil'''
: Возвращает имя секции. Список оканчивается элементом со значением '''nil'''
;Пример
;Пример
{{Content:MirLua/Example||code=
{{Content:MirLua/Example|code=
for setting in db.AllSettings(nil, 'CList') do
for setting in db.AllSettings(nil, 'CList') do
   local message = string.format("%s/%s = ", 'CList', setting, ...)
   local message = string.format("%s/%s = ", 'CList', setting, ...)
Line 133: Line 133:
: Возвращает '''true''' в случае успеха, иначе '''false'''
: Возвращает '''true''' в случае успеха, иначе '''false'''
;Пример
;Пример
{{Content:MirLua/Example||code=db.WriteSetting(nil, 'test', 'some', true)}}
{{Content:MirLua/Example|code=db.WriteSetting(nil, 'test', 'some', true)}}


=== DeleteSetting ===
=== DeleteSetting ===
Line 151: Line 151:
: Возвращает '''true''' в случае успеха, иначе '''false'''
: Возвращает '''true''' в случае успеха, иначе '''false'''
;Пример
;Пример
{{Content:MirLua/Example||code=db.DeleteSetting(nil, 'test', 'some')}}
{{Content:MirLua/Example|code=db.DeleteSetting(nil, 'test', 'some')}}


=== DeleteModule ===
=== DeleteModule ===
Line 166: Line 166:
: Возвращает '''true''' в случае успеха, иначе '''false'''
: Возвращает '''true''' в случае успеха, иначе '''false'''
;Пример
;Пример
{{Content:MirLua/Example||code=db.DeleteModule(nil, 'test')}}
{{Content:MirLua/Example|code=db.DeleteModule(nil, 'test')}}


[[Category:Руководства]]
[[Category:Руководства]]

Revision as of 21:18, 16 December 2015

Предоставляет доступ к данным и контактам в базе данных профиля пользователя.

Подключение модуля: local db = require('m_database')

<translate> Note</translate>
Параметры, выделенные жирным курсивом, являются обязательными.


Контакты

AllContacts

Итератор для списка контактов

Параметры
name
Тип: string
Имя протокола
Результат
Тип: number
Возвращает номер контакта. Список оканчивается элементом со значением nil
Пример
for hContact in db.AllContacts('JABBER_1') do
  print(db.GetSetting(hContact, 'JABBER_1', 'Nick'))
end


События

GetEventCount

Количество событий для контакта

Параметры
hContact
Тип: number
Номер контакта
Результат
Тип: number
Возвращает количество событий
Пример
db.GetEventCount(hContact)

AllEvents

Итератор для списка событий контакта от первого к последнему

Параметры
hContact
Тип: number
Номер контакта
Результат
Тип: number
Возвращает номер события. Список оканчивается элементом со значением nil
Пример
for hEvent in db.AllEvents(hContact) do
  local event = totable(hEvent, "DBEVENTINFO")
  print(event.Timestamp, event.Blob)
end

AllEventsFromEnd

Итератор для списка событий контакта от последнего к первому

Параметры
hContact
Тип: number
Номер контакта
Результат
Тип: number
Возвращает номер события. Список оканчивается элементом со значением nil
Пример
for hEvent in db.AllEventsFromEnd(hContact) do
  local event = totable(hEvent, "DBEVENTINFO")
  print(event.Timestamp, event.Blob)
end


Настройки

GetSetting

Возвращает значение настройки

Параметры
hContact
Тип: number
Номер контакта или nil
module
Тип: string
Название модуля
setting
Тип: string
Название настройки
value
Тип: number, string
Значание по умолчаниию
Результат
Тип: number
Возвращает значение настройки или значание по умолчаниию или nil
Пример
db.GetSetting(nil, 'test', 'some')

AllSettings

Итератор для секции настроек

Параметры
hContact
Тип: number
Номер контакта или nil
module
Тип: string
Название секции
Результат
Тип: number
Возвращает имя секции. Список оканчивается элементом со значением nil
Пример
for setting in db.AllSettings(nil, 'CList') do
  local message = string.format("%s/%s = ", 'CList', setting, ...)
   .. db.GetSetting(nil, 'CList', setting)
  print(message)
end

WriteSetting

Сохраняет значение в БД

Параметры
hContact
Тип: number
Номер контакта или nil
module
Тип: string
Название секции
setting
Тип: string
Название настройки
Результат
Тип: boolean
Возвращает true в случае успеха, иначе false
Пример
db.WriteSetting(nil, 'test', 'some', true)

DeleteSetting

Удаляет настройку

Параметры
hContact
Тип: number
Номер контакта или nil
module
Тип: string
Название секции
setting
Тип: string
Название настройки
Результат
Тип: boolean
Возвращает true в случае успеха, иначе false
Пример
db.DeleteSetting(nil, 'test', 'some')

DeleteModule

Удаляет секцию

Параметры
hContact
Тип: number
Номер контакта или nil
module
Тип: string
Название секции
Результат
Тип: boolean
Возвращает true в случае успеха, иначе false
Пример
db.DeleteModule(nil, 'test')
Retrieved from "https://wiki.miranda-ng.org/index.php?title=Plugin:MirLua/ru/m_database&oldid=18194"