Dataset methods: create, get, list
The Dataset Verbs create, get, list as typed SDK methods, with inputs, result, refusals and an example.
Reference for Dataset, one group of Dataset methods.
Dataset.create
Creates a Dataset. Verb page.
interface DatasetVerbs {
create(input: DatasetCreateInput, options?: SB.CallOptions): SB.Call<Dataset>
}Emits Dataset.created.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
name | string | required | The name of the Product. |
promise | text | required | What the Customer can rely on. |
records | integer | How many Things it holds. | |
refreshedAt | datetime | When its Sources were last read. | |
noun | Noun | A Dataset collects and vouches for the Things of exactly one Noun. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
dataset | Dataset | required | The Dataset. |
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 dataset = await $.Dataset.create({ name: 'Ratebook', promise: 'A rate for any US address in under 100 milliseconds.' })Dataset.get
Returns one Dataset by id. Verb page.
interface DatasetVerbs {
get(input: DatasetGetInput, options?: SB.CallOptions): SB.Call<Dataset>
}Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Dataset. |
at | string | A time or Version name: the record as it stood then. Unset: as it stands now. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
dataset | Dataset | required | The Dataset. |
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 dataset = await $.Dataset.get({ id: 'dataset_UDQXk0KsJB' })Dataset.list
Returns Datasets, newest first, one page at a time. Verb page.
interface DatasetVerbs {
list(input?: DatasetListInput, options?: SB.CallOptions): SB.ListCall<Dataset>
}Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
limit | integer | At most this many records, up to 100. The default is 20. | |
after | string | The cursor from the previous page. | |
where | string | A filter over the properties, such as paidAt = null and total.amount > 500. | |
sort | string | Properties to sort by, comma-separated; a leading minus sorts descending. | |
total | boolean | True adds the match count as meta.total, exact up to 10,000 matches and estimated above. | |
facets | string | Properties to count by value, comma-separated, returned as meta.facets. | |
fields | string | Properties to return on each record, comma-separated; $id and $type always return. | |
include | string | Related records to embed in place of their URLs, comma-separated. | |
depth | integer | How many levels of related records to embed. The default is 1. | |
q | string | Words to match across the text properties, ranked by relevance. | |
match | string | Ranks the search by words, or meaning; words is the default. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
datasets | list of Dataset | required | One page of Datasets. |
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 datasets = await $.Dataset.list({ limit: 20 })