API

Выгрузка в Parquet

Модуль 'ткд_ОбменДаннымиС'

---

ВыгрузитьТЗвПаркет

 ()

Функция ВыгрузитьТЗвПаркет(ТЗ, пОбработки = Неопределено) Экспорт

Выгружает таблицу значений в формат Parquet.

Параметры функции:

Имя	Тип	Обязательный	Описание
ТЗ	Таблица значений	Да	Выгружаемая таблица значений
пОбработки	Соответствие	Нет	Вспомогательные параметры выгрузки

Возвращаемое значение: Структура см. 'Структура Результата'

В поле результата Данные возвращаются ДвоичныеДанные сериализованной таблицы (Пример).

---

ВыгрузитьЗапросВПаркет

 ()

Функция ВыгрузитьЗапросВПаркет(ТекстЗапроса, Знач пЗапроса = Неопределено, Знач пОбработки = Неопределено) Экспорт

Выполняет запрос и выгружает результат выполнения запроса в Parquet. Результат запроса выгружается в таблицу значений штатным методом запроса - Выгрузить().

Параметры функции:

Имя	Тип	Обязательный	Описание
ТекстЗапроса	Строка	Да	Выгружаемая таблица значений
пЗапроса	Структура	Нет	Параметры запроса
пОбработки	Соответствие (Структура)	Нет	Вспомогательные параметры выгрузки

Возвращаемое значение: Структура см. 'Структура Результата'

---

ВыгрузитьПакетЗапросовВПаркет

 ()

Функция ВыгрузитьПакетЗапросовВПаркет(ОписаниеПакета, Знач пОбработки = Неопределено, МассивСсылок = Неопределено) Экспорт

Выгружает пакет запросов 1C в Parquet. Пример.

Параметры функции:

Имя	Тип	Обязательный	Описание
ОписаниеПакета	Структура	Да	Описание пакета запросов
пОбработки	Соответствие (Структура)	Нет	Вспомогательные параметры выгрузки
МассивСсылок	Массив ссылок -фильтр объектов пакета	Нет	Параметры запроса

Возвращаемое значение: Структура см. 'Структура Результата'.

В случае успешного выполнения Результат.Данные содержат двоичные данные - результат выгрузки в Parquet.

ОписаниеПакета - структура

Поле	Тип	Обязательный	Описание
ТекстЗапроса	Строка	Да	Текст пакета запросов
ПараметрыЗапроса	Структура	Нет	Параметры запроса
ИменаТаблиц	Таблица значений	Нет	Описание таблиц результатов выполнения пакета

ИменаТаблиц - таблица значений - описание таблиц параметров результатов запроса. Необязательный параметр. Возможно применение автоопределения параметров таблиц.

Поле	Тип	Описание
Имя	Строка	Имя таблицы
ТекстЗапроса	Строка	Текст запроса
Выгружать	Булево	Выгружать - признак выгрузки (нужно установить ложь для вспомогательных временных таблиц)
Главная	Таблица значений	Признак выгрузки таблицы как главной

Автоопределение параметров таблиц пакета - описание таблиц пакета можно опустить и задавать параметры таблиц непостредственно в тексте запроса. Описание каждой таблицы записывыается в виде комментария в первой строке запроса после оператора "ВЫБРАТЬ".

|ВЫБРАТЬ ...... // ИмяТаблицы Главная НеВыгружать

Где

• ИмяТаблицы - имя под которым таблица будет выгружена в Parquet
• Главная - признак главной таблицы (именно текст "Главная" (в любом регистре). Необязательный параметр, по умолчанию - ложь)
• НеВыгружать - отмена выгрузки таблицы (именно текст "НеВыгружать" (в любом регистре). Необязательный параметр - по умолчанию - ложь)

Первый параметр - обязательный, всегда используется в качестве имени таблицы. Параметры разделяются пробелами.

Примеры

|ВЫБРАТЬ ...... // Шапка_ЗаказПокупателя

|ВЫБРАТЬ ...... // ТЧ_Товары Главная

|ВЫБРАТЬ ...... ПОМЕСТИТЬ ВТ_НомераГТД // ВТ_НомераГТД НеВыгружать

---

СоздатьТаблицуИменЗапросов

 ()

Функция СоздатьТаблицуИменЗапросов() Экспорт

Возвращает пустую таблицу описаний таблиц запросов.

---

ДобавитьИмяТаблицы

 ()

Функция ДобавитьИмяТаблицы(ИменаТаблиц, Имя, ТекстЗапроса, Выгружать = Истина, Главная = Ложь) Экспорт

Добавляет имена таблиц в существующую таблицу имен.

---

Чтение данных Parquet

Модуль 'ткд_ОбменДаннымиС'

ПрочитатьПаркет

 ()

Функция ПрочитатьПаркет(ДД, пОбработки = Неопределено) Экспорт

Функция читает данные из формата Parquet.

Параметры функции:

Имя	Тип	Обязательный	Описание
ДД	Двоичные данные	Да	Загружаемые данные Parquet
пОбработки	Соответствие	Нет	Вспомогательные параметры загрузки

Возвращаемое значение: Структура см. 'Структура Результата'

При чтении выполняется:

• Замена типов ссылок. Правила замены типов описываются в правилах обмена.
• Автоматическая замена ссылок перечислений.
• Замена ссылок перечислений по правилам (см. правила обмена).
• Сопоставление ссылок по регистру "ПубличныеИдентификаторыСинхронизируемыхОбъектов".

Модуль 'ткд_ОбщегоНазначенияКС'

---

СтруктураРезультата

 ()

Функция СтруктураРезультата(Знач ДопПоля = Неопределено, Успешно = Истина) Экспорт

Возвращает унифицированную структуру результата обработки.

Параметры функции:

Имя	Тип	Обязательный	Описание
ДопПоля	Соответствие (Структура)	Нет	Доп. поля результата
Успешно	Булево	Нет	Флаг успешного выполнения (начальный)

Структуры данных

Структура результата

Большинство используемых функций возвращает унифицированную структуру результата выполнения.

Поля результата:

Имя	Тип	Описание
Успешно	Булево	Флаг успешного выполнения функции
ОбработаноОбъектов	Число	Кол-во обработанных объектов
ВремяОбработки	Число	Время выполнения функции в секундах
Ошибки	Массив	Строки ошибок
Сообщения	Массив	Строки сообщений
Данные	Произвольный	Данные полученные в результате работы функции

Шаблон сруктуры можно получить функцией: ткд_ОбщегоНазначенияКС.СтруктураРезультата

Доп. параметры методов