Collection methods: export, query
The Collection Verbs export, query as typed SDK methods, with inputs, result, refusals and an example.
Reference for Collection, one group of Collection methods.
Collection.export
Export writes a Collection’s records to a file or the Startup’s warehouse, once or on a schedule. Verb page.
interface CollectionVerbs {
export(input: CollectionExportInput, options?: SB.CallOptions): SB.Call<CollectionExportOutput>
}Emits Collection.exported.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
collection | Collection | required | The Collection to export. |
to | string | required | A file format, or the warehouse Integration that receives it. |
cadence | string | How often it repeats; omitted, it runs once. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
file | File | The exported File, for a one-time export. | |
collection | Collection | required | The Collection exported. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
import { $ } from 'startup-builder'
const { file, collection } = await $.Collection.export({ collection: 'collection_txTK8QorKn', to: 'Example to' })Collection.query
Query reads any Nouns the caller’s Permissions allow, by SQL or a Relationship path, across every System in one call. Verb page.
interface CollectionVerbs {
query(input: CollectionQueryInput, options?: SB.CallOptions): SB.Call<CollectionQueryOutput>
}Emits Collection.queried.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
query | text | required | SQL, or a Relationship path such as customer.subscriptions.invoices. |
save | boolean | True saves it as a Collection defined by the query. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
rows | json | required | The matching records. |
collection | Collection | required | The Collection the query read. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
import { $ } from 'startup-builder'
const { rows, collection } = await $.Collection.query({ query: 'Example query' })