metadata.js API metadata.js API

  • Документация к версии: 0.11.217

    • Программный интерфейс

    Показывать:

    Класс Pouch

    Определен в: src\pouchdb.js:9
    Модуль: pouchdb
    Родительский модуль: common

    Интерфейс локальной и сетевой баз данных PouchDB

    Содержит абстрактные методы методы и подписки на события PouchDB, отвечает за авторизацию, синхронизацию и доступ к данным в IndexedDB и на сервере

    Методы

    backup_database

    (
    • [do_zip]
    )
    асинхронный

    Определен в src\pouchdb.js:603

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

    Параметры:

    • [do_zip] Boolean optional
      • указывает на необходимость архивировать стоки таблиц в озу перед записью файла

    load_changes

    (
    • changes
    • options
    )
    Boolean

    Определен в src\pouchdb.js:536

    Загружает в менеджер изменения или полученные через allDocs данные

    Параметры:

    • changes Object
    • options Object

    Возвращает:

    Boolean:

    load_data

    ()

    Определен в src\pouchdb.js:211

    Загружает условно-постоянные данные из базы ram в alasql

    Используется при инициализации данных на старте приложения

    load_obj

    (
    • tObj
    )
    Promise.

    Определен в src\pouchdb.js:450

    Читает объект из pouchdb

    Параметры:

    • tObj DataObj
      • объект данных, который необходимо прочитать - дозаполнить

    Возвращает:

    Promise.:
    • промис с загруженным объектом

    load_obj

    (
    • tObj
    • attr
    )
    Promise.

    Определен в src\pouchdb.js:476

    Записывает объект в pouchdb

    Параметры:

    • tObj DataObj
      • записываемый объект
    • attr Object
      • ополнительные параметры записи

    Возвращает:

    Promise.:
    • промис с записанным объектом

    log_in

    (
    • username
    • password
    )
    Promise

    Определен в src\pouchdb.js:110

    Выполняет авторизацию и запускает репликацию

    Параметры:

    • username String
    • password String

    Возвращает:

    Promise:

    log_out

    ()

    Определен в src\pouchdb.js:147

    Останавливает синхронизации и снимает признак авторизованности

    reset_local_data

    ()

    Определен в src\pouchdb.js:180

    Уничтожает локальные данные

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

    restore_database

    () асинхронный

    Определен в src\pouchdb.js:621

    Восстанавливает базу из архивной копии

    run_sync

    (
    • local
    • remote
    • id
    )
    Promise.

    Определен в src\pouchdb.js:303

    Запускает процесс синхронизвации

    Параметры:

    • local PouchDB
    • remote PouchDB
    • id String

    Возвращает:

    Promise.:

    Свойства

    authorized

    Unknown

    Определен в src\pouchdb.js:280

    Информирует об авторизованности на сервере CouchDB

    data_loaded

    Unknown

    Определен в src\pouchdb.js:292

    Информирует о загруженности данных

    local

    Ram: PouchDB, doc: PouchDB, meta: PouchDB, sync:

    Определен в src\pouchdb.js:49

    Локальные базы PouchDB

    remote

    Ram: PouchDB, doc: PouchDB

    Определен в src\pouchdb.js:80

    Базы PouchDB на сервере