Cheat sheet#
NominalClient has a client for each area of Nominal, such as client.assets() for assets and client.catalog() for datasets and channels.
This project setup command and associated imports will prepare you to call any of the functions listed on this page.
cargo new nominal-cheatsheet
cd nominal-cheatsheet
cargo add nominal chrono
cargo add tokio --features full
use chrono::Utc; // chrono is the time library used by the nominal crate
use nominal::core::*; // AssetCreate, RunQuery and the other types below
let client = nominal::NominalClient::from_profile("default")?;
Assets#
Action |
Ref |
Rust |
|---|---|---|
Create an asset |
|
|
Get an asset by RID |
|
|
Search by label |
|
|
Add a dataset under a ref name |
|
|
Replace labels |
|
|
Archive |
|
Runs#
Action |
Ref |
Rust |
|---|---|---|
Start a run on an asset now |
|
|
End an open run |
|
|
Get a run by RID |
|
|
Search by label |
|
|
Add a dataset to a run with no assets |
|
|
Archive |
|
Datasets and channels#
Action |
Ref |
Rust |
|---|---|---|
Create a dataset |
|
|
Get a dataset by RID |
|
|
Search by part of the name |
|
|
List a datasetβs channels |
|
|
Archive |
|
Files and drives#
Action |
Ref |
Rust |
|---|---|---|
Upload a CSV into a new dataset |
|
|
Wait for the uploadβs ingest job |
|
|
Get a drive by name |
|
|
List a drive folder |
|
Workbooks#
Beyond NominalClient#
Stream points as your program produces them: Stream data
Query your data with SQL: Query data with SQL
Create events and checklists, and execute a checklist on a run: Call the REST API directly
Create runs that select tagged data: Simulation runs