dune-api 0.1.0

Unofficial Rust client for the Dune Analytics API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

//! Types for the Pipelines API

use serde::{Deserialize, Serialize};
use std::collections::HashMap;

/// Pipeline execution request
#[derive(Debug, Clone, Serialize)]
pub struct ExecutePipelineRequest {
    /// Pipeline definition
    pub pipeline: Pipeline,
    /// Query parameters for all queries in the pipeline
    #[serde(skip_serializing_if = "Option::is_none")]
    pub query_parameters: Option<HashMap<String, String>>,
    /// Performance tier (medium, large)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub performance: Option<String>,
}

/// Pipeline definition
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Pipeline {
    /// Pipeline nodes
    pub nodes: Vec<PipelineNode>,
}

/// Pipeline node
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct PipelineNode {
    /// Node type (query_execution, materialized_view_refresh)
    #[serde(rename = "type")]
    pub node_type: String,
    /// Query ID (for query_execution type)
    pub query_id: Option<i64>,
    /// Materialized view name (for materialized_view_refresh type)
    pub matview_name: Option<String>,
    /// Dependencies (IDs of nodes that must complete first)
    #[serde(default)]
    pub depends_on: Vec<String>,
    /// Node ID
    pub id: Option<String>,
}

impl PipelineNode {
    /// Create a query execution node
    pub fn query(query_id: i64) -> Self {
        Self {
            node_type: "query_execution".to_string(),
            query_id: Some(query_id),
            matview_name: None,
            depends_on: vec![],
            id: None,
        }
    }

    /// Create a materialized view refresh node
    pub fn matview(name: &str) -> Self {
        Self {
            node_type: "materialized_view_refresh".to_string(),
            query_id: None,
            matview_name: Some(name.to_string()),
            depends_on: vec![],
            id: None,
        }
    }

    /// Set node ID
    pub fn with_id(mut self, id: &str) -> Self {
        self.id = Some(id.to_string());
        self
    }

    /// Set dependencies
    pub fn depends_on(mut self, deps: Vec<String>) -> Self {
        self.depends_on = deps;
        self
    }
}

/// Response from executing a pipeline
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct ExecutePipelineResponse {
    /// Pipeline execution ID
    pub pipeline_execution_id: Option<String>,
    /// Node executions
    #[serde(default)]
    pub node_executions: Vec<NodeExecution>,
}

/// Node execution info
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct NodeExecution {
    /// Node ID
    pub node_id: Option<String>,
    /// Execution ID
    pub execution_id: Option<String>,
    /// State
    pub state: Option<String>,
}

/// Pipeline execution status
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct PipelineExecutionStatus {
    /// Pipeline execution ID
    pub pipeline_execution_id: Option<String>,
    /// Overall state
    pub state: Option<String>,
    /// Whether execution is finished
    pub is_execution_finished: Option<bool>,
    /// Node statuses
    #[serde(default)]
    pub node_executions: Vec<NodeExecutionStatus>,
}

/// Node execution status
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct NodeExecutionStatus {
    /// Node ID
    pub node_id: Option<String>,
    /// Node type
    #[serde(rename = "type")]
    pub node_type: Option<String>,
    /// Execution ID
    pub execution_id: Option<String>,
    /// State
    pub state: Option<String>,
    /// Query ID
    pub query_id: Option<i64>,
    /// Materialized view name
    pub matview_name: Option<String>,
}