olai-uc-common 0.0.2

Shared types, generated Unity Catalog models, and storage/REST abstractions for the Unity Catalog server and client crates.
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

// @generated
// This file is @generated by prost-build.
/// A schema is a namespace within a catalog that contains tables.
#[cfg_attr(feature = "python", ::pyo3::pyclass(get_all, set_all))]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Schema {
    /// Name of schema, relative to parent catalog.
    #[prost(string, tag="1")]
    pub name: ::prost::alloc::string::String,
    /// Name of parent catalog.
    #[prost(string, tag="2")]
    pub catalog_name: ::prost::alloc::string::String,
    /// Full name of schema, in form of catalog_name.schema_name.
    #[prost(string, tag="3")]
    pub full_name: ::prost::alloc::string::String,
    /// User-provided free-form text description.
    #[prost(string, optional, tag="4")]
    pub comment: ::core::option::Option<::prost::alloc::string::String>,
    /// A map of key-value properties attached to the securable.
    #[prost(map="string, string", tag="5")]
    pub properties: ::std::collections::HashMap<::prost::alloc::string::String, ::prost::alloc::string::String>,
    /// Username of current owner of schema.
    #[prost(string, optional, tag="6")]
    pub owner: ::core::option::Option<::prost::alloc::string::String>,
    /// Time at which this schema was created, in epoch milliseconds.
    #[prost(int64, optional, tag="7")]
    pub created_at: ::core::option::Option<i64>,
    /// Username of schema creator.
    #[prost(string, optional, tag="8")]
    pub created_by: ::core::option::Option<::prost::alloc::string::String>,
    /// Time at which this schema was last updated, in epoch milliseconds.
    #[prost(int64, optional, tag="9")]
    pub updated_at: ::core::option::Option<i64>,
    /// Username of user who last modified schema.
    #[prost(string, optional, tag="10")]
    pub updated_by: ::core::option::Option<::prost::alloc::string::String>,
    /// Unique identifier for the schema.
    #[prost(string, optional, tag="11")]
    pub schema_id: ::core::option::Option<::prost::alloc::string::String>,
    /// Storage root URL for managed storage location of the schema.
    ///
    /// Can be set when creating a schema. When set, managed tables/volumes created
    /// in this schema are rooted here; otherwise the parent catalog's storage
    /// location is used. Example: `s3://bucket/ucroot`.
    #[prost(string, optional, tag="12")]
    pub storage_root: ::core::option::Option<::prost::alloc::string::String>,
    /// Storage location URL (full path) for managed storage of the schema.
    ///
    /// A unique path under `storage_root`. Absent when the schema has no
    /// `storage_root`, in which case managed securables fall back to the parent
    /// catalog's storage location.
    /// Example: `s3://bucket/ucroot/__unitystorage/schemas/{schema_id}`.
    #[prost(string, optional, tag="13")]
    pub storage_location: ::core::option::Option<::prost::alloc::string::String>,
}
/// List Schemas in a catalog
#[cfg_attr(feature = "python", ::pyo3::pyclass(get_all, set_all))]
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct ListSchemasRequest {
    /// Name of parent catalog.
    #[prost(string, tag="1")]
    pub catalog_name: ::prost::alloc::string::String,
    /// The maximum number of results per page that should be returned.
    #[prost(int32, optional, tag="2")]
    pub max_results: ::core::option::Option<i32>,
    /// Opaque pagination token to go to next page based on previous query.
    #[prost(string, optional, tag="3")]
    pub page_token: ::core::option::Option<::prost::alloc::string::String>,
    /// Whether to include schemas in the response for which the principal can only access selective metadata for
    #[prost(bool, optional, tag="4")]
    pub include_browse: ::core::option::Option<bool>,
}
/// List Schemas response.
#[cfg_attr(feature = "python", ::pyo3::pyclass(get_all, set_all))]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListSchemasResponse {
    /// The schemas returned.
    #[prost(message, repeated, tag="1")]
    pub schemas: ::prost::alloc::vec::Vec<Schema>,
    /// The next_page_token value to include in the next List request.
    #[prost(string, optional, tag="2")]
    pub next_page_token: ::core::option::Option<::prost::alloc::string::String>,
}
/// Create a new Schema
#[cfg_attr(feature = "python", ::pyo3::pyclass(get_all, set_all))]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateSchemaRequest {
    /// Name of schema, relative to parent catalog.
    #[prost(string, tag="1")]
    pub name: ::prost::alloc::string::String,
    /// Name of parent catalog.
    #[prost(string, tag="2")]
    pub catalog_name: ::prost::alloc::string::String,
    /// User-provided free-form text description.
    #[prost(string, optional, tag="3")]
    pub comment: ::core::option::Option<::prost::alloc::string::String>,
    /// A map of key-value properties attached to the securable.
    #[prost(map="string, string", tag="4")]
    pub properties: ::std::collections::HashMap<::prost::alloc::string::String, ::prost::alloc::string::String>,
    /// Storage root URL for managed storage location of the schema.
    ///
    /// If not set, managed securables under this schema fall back to the parent
    /// catalog's storage location. Example: `s3://bucket/ucroot`.
    #[prost(string, optional, tag="5")]
    pub storage_root: ::core::option::Option<::prost::alloc::string::String>,
}
/// Get a Schema
#[cfg_attr(feature = "python", ::pyo3::pyclass(get_all, set_all))]
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct GetSchemaRequest {
    /// Full name of schema.
    ///
    /// Format: catalog_name.schema_name
    #[prost(string, tag="1")]
    pub full_name: ::prost::alloc::string::String,
}
/// Update a Schema
#[cfg_attr(feature = "python", ::pyo3::pyclass(get_all, set_all))]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateSchemaRequest {
    /// Full name of schema, in form of catalog_name.schema_name.
    #[prost(string, tag="1")]
    pub full_name: ::prost::alloc::string::String,
    /// User-provided free-form text description.
    #[prost(string, optional, tag="2")]
    pub comment: ::core::option::Option<::prost::alloc::string::String>,
    /// A map of key-value properties attached to the securable.
    ///
    /// When provided in update request, the specified properties will override the existing properties.
    /// To add and remove properties, one would need to perform a read-modify-write.
    #[prost(map="string, string", tag="3")]
    pub properties: ::std::collections::HashMap<::prost::alloc::string::String, ::prost::alloc::string::String>,
    /// Name of schema.
    #[prost(string, optional, tag="4")]
    pub new_name: ::core::option::Option<::prost::alloc::string::String>,
}
/// Delete a Schema
#[cfg_attr(feature = "python", ::pyo3::pyclass(get_all, set_all))]
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct DeleteSchemaRequest {
    /// Full name of schema to delete.
    ///
    /// Format: catalog_name.schema_name
    #[prost(string, tag="1")]
    pub full_name: ::prost::alloc::string::String,
    /// Force deletion even if the schema is not empty.
    #[prost(bool, optional, tag="2")]
    pub force: ::core::option::Option<bool>,
}
include!("unitycatalog.schemas.v1.serde.rs");
// @@protoc_insertion_point(module)