lance_namespace_reqwest_client/models/create_materialized_view_request.rs
1/*
2 * Lance Namespace Specification
3 *
4 * This OpenAPI specification is a part of the Lance namespace specification. It contains 2 parts: The `components/schemas`, `components/responses`, `components/examples`, `tags` sections define the request and response shape for each operation in a Lance Namespace across all implementations. See https://lance.org/format/namespace/operations for more details. The `servers`, `security`, `paths`, `components/parameters` sections are for the Lance REST Namespace implementation, which defines a complete REST server that can work with Lance datasets. See https://lance.org/format/namespace/rest for more details.
5 *
6 * The version of the OpenAPI document: 1.0.0
7 *
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
15pub struct CreateMaterializedViewRequest {
16 #[serde(rename = "identity", skip_serializing_if = "Option::is_none")]
17 pub identity: Option<Box<models::Identity>>,
18 /// Arbitrary context as key-value pairs. How to use the context is custom to the specific implementation. On a request, it carries caller-provided context to the implementation. On a response, it carries implementation-provided context back to the caller. REST NAMESPACE ONLY Context entries are mapped to and from HTTP headers using the `header.` prefix: - On a request, any entry whose key starts with `header.` is sent as an HTTP request header with the prefix stripped. For example, the entry `{\"header.Authorization\": \"Bearer abc\"}` is sent as the request header `Authorization: Bearer abc`. - On a response, every HTTP response header is returned as an entry whose key is the header name prefixed with `header.`. For example, the response header `x-request-id: abc123` is returned as the entry `{\"header.x-request-id\": \"abc123\"}`.
19 #[serde(rename = "context", skip_serializing_if = "Option::is_none")]
20 pub context: Option<std::collections::HashMap<String, String>>,
21 /// View identifier path (namespace + view name)
22 #[serde(rename = "id", skip_serializing_if = "Option::is_none")]
23 pub id: Option<Vec<String>>,
24 /// The materialized view kind. - `query` — plain query-backed view (no UDTF), 1:1 rows. - `udtf` — batch UDTF-backed view (N:M rows, full refresh). - `chunker`, aka 'scalar_udtf' — chunker view (1:N row expansion, incremental refresh).
25 #[serde(rename = "kind")]
26 pub kind: Kind,
27 /// Opaque serialized representation of the source query that defines the view's input. The format is defined by the client; the namespace server stores it without interpreting it.
28 #[serde(rename = "source_query")]
29 pub source_query: String,
30 /// Base64-encoded Arrow schema of the view output
31 #[serde(rename = "output_schema")]
32 pub output_schema: String,
33 #[serde(rename = "udtf_spec", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
34 pub udtf_spec: Option<Option<Box<models::MaterializedViewUdtfEntry>>>,
35 /// If false, the server kicks off an initial refresh immediately after creating the view and the response includes a job ID.
36 #[serde(rename = "with_no_data", skip_serializing_if = "Option::is_none")]
37 pub with_no_data: Option<bool>,
38 /// If true, the view is automatically refreshed when source-table data changes past the deployment-level threshold. Boolean opt-in only; the threshold and cooldown are configured on the deployment, not per-view.
39 #[serde(rename = "auto_refresh", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
40 pub auto_refresh: Option<Option<bool>>,
41}
42
43impl CreateMaterializedViewRequest {
44 pub fn new(kind: Kind, source_query: String, output_schema: String) -> CreateMaterializedViewRequest {
45 CreateMaterializedViewRequest {
46 identity: None,
47 context: None,
48 id: None,
49 kind,
50 source_query,
51 output_schema,
52 udtf_spec: None,
53 with_no_data: None,
54 auto_refresh: None,
55 }
56 }
57}
58/// The materialized view kind. - `query` — plain query-backed view (no UDTF), 1:1 rows. - `udtf` — batch UDTF-backed view (N:M rows, full refresh). - `chunker`, aka 'scalar_udtf' — chunker view (1:N row expansion, incremental refresh).
59#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
60pub enum Kind {
61 #[serde(rename = "query")]
62 Query,
63 #[serde(rename = "udtf")]
64 Udtf,
65 #[serde(rename = "chunker")]
66 Chunker,
67}
68
69impl Default for Kind {
70 fn default() -> Kind {
71 Self::Query
72 }
73}
74