LogDataSource

Defined in: js-api/src/dapi.ts:2276

Common functionality for handling collections of entities stored on the server. Works with Datagrok REST API, allows to get filtered and paginated lists of entities, Can be extended with specific methods. (i.e. UsersDataSource)

The fluent methods (filter, order, page, by, include, ...) are immutable: each returns a new source and leaves this one as it was, so a source can be kept in a variable and reused as a starting point.

Example

const projects = grok.dapi.projects.order('createdOn', true);
const recent = await projects.filter('createdOn > -1w').list({pageSize: 20});
const all = await projects.list();   // still unfiltered

Extends

• HttpDataSource<LogEvent>

Constructors

Constructor

new LogDataSource(s): LogDataSource

Defined in: js-api/src/dapi.ts:2277

Parameters

Parameter	Type
s	any

Returns

LogDataSource

Overrides

HttpDataSource.constructor

Properties

Property	Type	Inherited from	Defined in
clsName	string	HttpDataSource.clsName	js-api/src/dapi.ts:333
dart	any	HttpDataSource.dart	js-api/src/dapi.ts:332

Accessors

activity

Get Signature

get activity(): ActivityDataSource

Defined in: js-api/src/dapi.ts:2282

Activity API endpoint

Returns

ActivityDataSource

Methods

allPackageVersions()

allPackageVersions(): this

Defined in: js-api/src/dapi.ts:414

A source without package version isolation: entities of all package versions, not only the current one.

Returns

this

Inherited from

HttpDataSource.allPackageVersions

---

by()

by(i): this

Defined in: js-api/src/dapi.ts:419

A source that returns at most [i] entities per page. See also page.

Parameters

Parameter	Type
i	number

Returns

this

Inherited from

HttpDataSource.by

---

count()

count(): Promise<number>

Defined in: js-api/src/dapi.ts:385

Counts entities that satisfy the filtering criteria (see filter). See examples: https://public.datagrok.ai/js/samples/dapi/projects-list Smart filter: https://datagrok.ai/help/datagrok/smart-search

Returns

Promise<number>

Inherited from

HttpDataSource.count

---

delete()

delete(e): Promise<void>

Defined in: js-api/src/dapi.ts:409

Deletes an entity.

Parameters

Parameter	Type
e	DartObject

Returns

Promise<void>

Inherited from

HttpDataSource.delete

---

filter()

filter(w): this

Defined in: js-api/src/dapi.ts:439

A source filtered by [w]; replaces the filter of this source, if any. Also can be set with list method "options" parameter See example: https://public.datagrok.ai/js/samples/dapi/projects-list Smart filter: https://datagrok.ai/help/datagrok/concepts/objects#entity-search

Parameters

Parameter	Type
w	string

Returns

this

Inherited from

HttpDataSource.filter

---

find()

find(id): Promise<LogEvent>

Defined in: js-api/src/dapi.ts:399

Returns an entity with the specified id. Throws an exception if an entity does not exist, or is not accessible in the current context. Sample: https://public.datagrok.ai/js/samples/data-access/save-and-load-df

Parameters

Parameter	Type	Description
id	string	GUID of the corresponding object

Returns

Promise<LogEvent>

{Promise<object>} - entity.

Inherited from

HttpDataSource.find

---

first()

first(): Promise<LogEvent>

Defined in: js-api/src/dapi.ts:390

Returns the first entity that satisfies the filtering criteria (see filter).

Returns

Promise<LogEvent>

Inherited from

HttpDataSource.first

---

getArchiveEvents()

getArchiveEvents(connection, key): Promise<DataFrame>

Defined in: js-api/src/dapi.ts:2329

Decodes one archived object into log events, same shape as getCloudLogEvents.

Parameters

Parameter	Type
connection	string
key	string

Returns

Promise<DataFrame>

---

getArchiveObjects()

getArchiveObjects(connection, options?): Promise<DataFrame>

Defined in: js-api/src/dapi.ts:2324

Objects in the write-once log archive under prefix — key, modified, size.

Listing is the archive's only index; the keys carry the delivery date. connection is an S3 data connection pointing at the archive bucket.

Parameters

Parameter	Type
connection	string
options?	{ limit?: number; prefix?: string; }
options.limit?	number
options.prefix?	string

Returns

Promise<DataFrame>

---

getCloudLogEvents()

getCloudLogEvents(group, start, end, options?): Promise<DataFrame>

Defined in: js-api/src/dapi.ts:2312

Events from a cloud log group — the hot, queryable tier (30 days).

filter is a CloudWatch filter pattern, not a regular expression: a bare word matches a substring, ?a ?b is OR, -x excludes.

Parameters

Parameter	Type
group	string
start	Dayjs
end	Dayjs
options?	{ connection?: string; filter?: string; limit?: number; }
options.connection?	string
options.filter?	string
options.limit?	number

Returns

Promise<DataFrame>

Example

const df = await grok.dapi.log.getCloudLogEvents('/datagrok/public',
  dayjs().subtract(1, 'hour'), dayjs(), {filter: 'error'});

---

getCloudLogGroups()

getCloudLogGroups(options?): Promise<string[]>

Defined in: js-api/src/dapi.ts:2298

Names of the cloud log groups this instance can read.

Admins only. Without a connection the server uses its own AWS role.

Parameters

Parameter	Type
options?	{ connection?: string; prefix?: string; }
options.connection?	string
options.prefix?	string

Returns

Promise<string[]>

Example

const groups = await grok.dapi.log.getCloudLogGroups({prefix: '/datagrok/'});

---

include()

include(include): this

Defined in: js-api/src/dapi.ts:449

A source that also loads the [include]d properties of every entity (adds to this source's includes).

Parameters

Parameter	Type
include	string

Returns

this

Inherited from

HttpDataSource.include

---

list()

list(options?): Promise<LogEvent[]>

Defined in: js-api/src/dapi.ts:369

Returns all entities that satisfy the filtering criteria (see filter). See examples: https://public.datagrok.ai/js/samples/dapi/projects-list Smart filter: https://datagrok.ai/help/datagrok/smart-search

Parameters

Parameter	Type
options	{ filter?: string; order?: string; pageNumber?: number; pageSize?: number; }
options.filter?	string
options.order?	string
options.pageNumber?	number
options.pageSize?	number

Returns

Promise<LogEvent[]>

Inherited from

HttpDataSource.list

---

nextPage()

nextPage(): this

Defined in: js-api/src/dapi.ts:431

A source for the page after this one (the first call gives page 1). Reassign to advance: source = source.nextPage(). See examples: https://public.datagrok.ai/js/samples/dapi/projects-list

Returns

this

Inherited from

HttpDataSource.nextPage

---

order()

order(fieldName, desc?): this

Defined in: js-api/src/dapi.ts:444

A source ordered by [fieldName]; replaces the order of this source, if any.

Parameters

Parameter	Type	Default value
fieldName	string	undefined
desc	boolean	false

Returns

this

Inherited from

HttpDataSource.order

---

page()

page(i): this

Defined in: js-api/src/dapi.ts:424

A source restricted to page [i]. See also nextPage.

Parameters

Parameter	Type
i	number

Returns

this

Inherited from

HttpDataSource.page

---

save()

save(e): Promise<LogEvent>

Defined in: js-api/src/dapi.ts:404

Saves an entity; the saved copy comes back with this source's includes loaded.

Parameters

Parameter	Type
e	DartObject

Returns

Promise<LogEvent>

Inherited from

HttpDataSource.save

---

where()

where(options?): LogDataSource

Defined in: js-api/src/dapi.ts:2286

Parameters

Parameter	Type
options?	{ end?: Dayjs; entityId?: string; favoritesOnly?: boolean; start?: Dayjs; }
options.end?	Dayjs
options.entityId?	string
options.favoritesOnly?	boolean
options.start?	Dayjs

Returns

LogDataSource

---

with()

protected with(patch): this

Defined in: js-api/src/dapi.ts:344

A copy of this source whose query has [patch] applied. The Dart handle is shared; its state is rebuilt from the query right before every request, so the copies never observe each other.

Parameters

Parameter	Type
patch	Partial<DataSourceQuery>

Returns

this

Inherited from

HttpDataSource.with