Database - Corsair

The Canvas plugin syncs data locally. Use corsair.canvas.db.<entity>.search({ data, limit?, offset? }) with the filters listed per entity.

New to Corsair? See database operations, data synchronization, and multi-tenancy.

Accounts

Path: canvas.db.accounts.search

const rows = await corsair.canvas.db.accounts.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`uuid`	`string`	equals, contains, startsWith, endsWith, in
`sis_account_id`	`string`	equals, contains, startsWith, endsWith, in
`workflow_state`	`string`	equals, contains, startsWith, endsWith, in

Every .search() also accepts limit and offset for pagination. .list() is available on the same path without the .search suffix in code — see database operations.

Assignments

Path: canvas.db.assignments.search

const rows = await corsair.canvas.db.assignments.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`due_at`	`string`	equals, contains, startsWith, endsWith, in
`points_possible`	`number`	equals, gt, gte, lt, lte, in
`published`	`boolean`	equals

Every .search() also accepts limit and offset for pagination. .list() is available on the same path without the .search suffix in code — see database operations.

Courses

Path: canvas.db.courses.search

const rows = await corsair.canvas.db.courses.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`course_code`	`string`	equals, contains, startsWith, endsWith, in
`uuid`	`string`	equals, contains, startsWith, endsWith, in
`sis_course_id`	`string`	equals, contains, startsWith, endsWith, in
`workflow_state`	`string`	equals, contains, startsWith, endsWith, in

Every .search() also accepts limit and offset for pagination. .list() is available on the same path without the .search suffix in code — see database operations.

Enrollments

Path: canvas.db.enrollments.search

const rows = await corsair.canvas.db.enrollments.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`type`	`string`	equals, contains, startsWith, endsWith, in
`enrollment_state`	`string`	equals, contains, startsWith, endsWith, in
`role`	`string`	equals, contains, startsWith, endsWith, in

Every .search() also accepts limit and offset for pagination. .list() is available on the same path without the .search suffix in code — see database operations.

Users

Path: canvas.db.users.search

const rows = await corsair.canvas.db.users.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`sortable_name`	`string`	equals, contains, startsWith, endsWith, in
`short_name`	`string`	equals, contains, startsWith, endsWith, in
`sis_user_id`	`string`	equals, contains, startsWith, endsWith, in
`login_id`	`string`	equals, contains, startsWith, endsWith, in
`email`	`string`	equals, contains, startsWith, endsWith, in

Every .search() also accepts limit and offset for pagination. .list() is available on the same path without the .search suffix in code — see database operations.