# Cheat sheet

[`NominalClient`](https://dev.nominal.io/rust-client/ref/rust/nominal/struct.NominalClient.md "nominal::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.

```shell
cargo new nominal-cheatsheet
cd nominal-cheatsheet
cargo add nominal chrono
cargo add tokio --features full
```

```rust
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 | [`📄`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.AssetsClient.md#method.create "nominal::core::AssetsClient::create") | `client.assets().create(AssetCreate::new("Engine 1").labels(["prototype"])).await?` |
| Get an asset by RID | [`📄`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.AssetsClient.md#method.get "nominal::core::AssetsClient::get") | `client.assets().get("<rid>").await?` |
| Search by label | [`📄`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.AssetsClient.md#method.search "nominal::core::AssetsClient::search") | `client.assets().search(AssetQuery::label("prototype")).await?` |
| Add a dataset under a [ref name](https://dev.nominal.io/platform/data-model.md#data-scopes-and-ref-names) | [`📄`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.AssetsClient.md#method.add_dataset "nominal::core::AssetsClient::add_dataset") | `client.assets().add_dataset(asset.rid(), "telemetry", dataset.rid()).await?` |
| Replace labels | [`📄`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.AssetsClient.md#method.update "nominal::core::AssetsClient::update") | `client.assets().update(asset.rid(), AssetUpdate::new().labels(["prototype", "flight"])).await?` |
| Archive | [`📄`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.AssetsClient.md#method.archive "nominal::core::AssetsClient::archive") | `client.assets().archive(asset.rid()).await?` |

## Runs

| Action | Ref | Rust |
| --- | --- | --- |
| Start a run on an asset now | [`📄`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.RunsClient.md#method.create "nominal::core::RunsClient::create") | `client.runs().create(RunCreate::new("Engine test 1", Utc::now()).assets([asset.rid()])).await?` |
| End an open run | [`📄`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.RunsClient.md#method.update "nominal::core::RunsClient::update") | `client.runs().update(run.rid(), RunUpdate::new().end(Utc::now())).await?` |
| Get a run by RID | [`📄`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.RunsClient.md#method.get "nominal::core::RunsClient::get") | `client.runs().get("<rid>").await?` |
| Search by label | [`📄`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.RunsClient.md#method.search "nominal::core::RunsClient::search") | `client.runs().search(RunQuery::label("acceptance")).await?` |
| Add a dataset to a run with no assets | [`📄`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.RunsClient.md#method.add_dataset "nominal::core::RunsClient::add_dataset") | `client.runs().add_dataset(run.rid(), "telemetry", dataset.rid()).await?` |
| Archive | [`📄`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.RunsClient.md#method.archive "nominal::core::RunsClient::archive") | `client.runs().archive(run.rid()).await?` |

## Datasets and channels

| Action | Ref | Rust |
| --- | --- | --- |
| Create a dataset | [`📄`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.CatalogClient.md#method.create_dataset "nominal::core::CatalogClient::create_dataset") | `client.catalog().create_dataset(DatasetCreate::new("Engine test 1")).await?` |
| Get a dataset by RID | [`📄`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.CatalogClient.md#method.get_dataset "nominal::core::CatalogClient::get_dataset") | `client.catalog().get_dataset("<rid>").await?` |
| Search by part of the name | [`📄`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.CatalogClient.md#method.search_datasets "nominal::core::CatalogClient::search_datasets") | `client.catalog().search_datasets(DatasetQuery::substring_match("Engine")).await?` |
| List a dataset’s channels | [`📄`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.CatalogClient.md#method.list_channels "nominal::core::CatalogClient::list_channels") | `client.catalog().list_channels(dataset.rid()).await?` |
| Archive | [`📄`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.CatalogClient.md#method.archive_dataset "nominal::core::CatalogClient::archive_dataset") | `client.catalog().archive_dataset(dataset.rid()).await?` |

## Files and drives

| Action | Ref | Rust |
| --- | --- | --- |
| Upload a CSV into a new dataset | [`📄`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.IngestClient.md#method.upload_csv "nominal::core::IngestClient::upload_csv") | `client.ingest().upload_csv("test.csv", DatasetCreate::new("Engine test 1"), CsvIngest::new(Timestamp::iso8601("timestamp"))).await?` |
| Wait for the upload’s ingest job | [`📄`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.IngestClient.md#method.wait_for_ingest_job "nominal::core::IngestClient::wait_for_ingest_job") | `client.ingest().wait_for_ingest_job(job.rid()).await?` |
| Get a drive by name | [`📄`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.DrivesClient.md#method.get_by_id "nominal::core::DrivesClient::get_by_id") | `client.drives().get_by_id("test-reports").await?` |
| List a drive folder | [`📄`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.DriveFilesClient.md#method.list "nominal::core::DriveFilesClient::list") | `client.files(drive.rid()).list("reports", false).await?` |

## Workbooks

| Action | Ref | Rust |
| --- | --- | --- |
| Get a template by RID | [`📄`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.TemplatesClient.md#method.get "nominal::core::TemplatesClient::get") | `client.templates().get("<rid>").await?` |
| Create a workbook for a run | [`📄`](https://dev.nominal.io/rust-client/ref/rust/nominal/core/struct.WorkbooksClient.md#method.create_from_template "nominal::core::WorkbooksClient::create_from_template") | `client.workbooks().create_from_template(&template, WorkbookDataScope::runs([run.rid()]), WorkbookCreate::new()).await?` |

## Beyond `NominalClient`

- Stream points as your program produces them: [Stream data](https://dev.nominal.io/rust-client/guides/stream.md)
- Query your data with SQL: [Query data with SQL](https://dev.nominal.io/rust-client/guides/sql.md)
- Create events and checklists, and execute a checklist on a run: [Call the REST API directly](https://dev.nominal.io/rust-client/guides/rest-api.md)
- Create runs that select tagged data: [Simulation runs](https://dev.nominal.io/rust-client/examples/simulation-runs.md)
