SDK

SDK

new SDK(configopt)

Source:

Constructor

Parameters:
Name Type Attributes Default Description
config SDKConfig <optional>
null

config

Members

beforeRequest

Source:
Properties:
Type Description
function

config

Source:
Properties:
Type Description
SDKConfig

Methods

cancelActiveRequests()

Source:

Отменяет все активные запросы

getData(query, offsetopt, limitopt, debugopt) → {PromiseCancelable.<DremioResult, Error>}

Source:

Выполняет запрос

Parameters:
Name Type Attributes Default Description
query IQuerySchema

query

offset Number <optional>
0

offset

limit Number <optional>
10

limit

debug Boolean <optional>
false

debug

Returns:
Type
PromiseCancelable.<DremioResult, Error>

getEntityByPath(pathopt) → {PromiseCancelable.<(DremioContainerInfo|DremioEntityInfo), Error>}

Source:

Возвращает сущность dremio.CatalogEntity по path

Parameters:
Name Type Attributes Default Description
path Array <optional>
null

путь

Returns:
Type
PromiseCancelable.<(DremioContainerInfo|DremioEntityInfo), Error>

getPermissions() → {PromiseCancelable.<DremioPermissions, Error>}

Source:

Возвращает список прав текущего пользователя (если задан authToken SDK#config и он валиден)

Returns:
Type
PromiseCancelable.<DremioPermissions, Error>

getPermissionsInfo() → {PromiseCancelable.<Array.<DremioPermissionInfo>, Error>}

Source:

Возвращает информацию о правах

Returns:
Type
PromiseCancelable.<Array.<DremioPermissionInfo>, Error>

getRootEntities() → {PromiseCancelable.<Array.<DremioRootEntity>, Error>}

Source:

Возрвщает root сущности dremio

Returns:
Type
PromiseCancelable.<Array.<DremioRootEntity>, Error>