Struct ProgramInfo 

pub struct ProgramInfo {
    pub circuit_ir: Option<Value>,
    pub dataflow: Option<Dataflow>,
    pub input_connectors: HashMap<String, InputEndpointConfig>,
    pub main_rust: Option<String>,
    pub output_connectors: HashMap<String, OutputEndpointConfig>,
    pub schema: Value,
    pub udf_stubs: Option<String>,
}

Program information is the output of the SQL compiler.

It includes information needed for Rust compilation (e.g., generated Rust code) as well as only for runtime (e.g., schema, input/output connectors).

JSON schema

{
 "description": "Program information is the output of the SQL compiler.\n\nIt includes information needed for Rust compilation (e.g., generated Rust code)\nas well as only for runtime (e.g., schema, input/output connectors).",
 "type": "object",
 "required": [
   "input_connectors",
   "output_connectors",
   "schema"
 ],
 "properties": {
   "circuit_ir": {
     "description": "JIT circuit IR (`allOperators`) captured by the SQL compiler for Gen-2\nprograms; the Gen-2 engine reads it to build the circuit.\n\nNot returned by the API. It runs to several MiB and reaches the pipeline\nthrough the program info artifact, so a pipeline read never carries it."
   },
   "dataflow": {
     "oneOf": [
       {
         "type": "null"
       },
       {
         "allOf": [
           {
             "$ref": "#/components/schemas/Dataflow"
           }
         ]
       }
     ]
   },
   "input_connectors": {
     "description": "Input connectors derived from the schema.",
     "type": "object",
     "additionalProperties": {
       "$ref": "#/components/schemas/InputEndpointConfig"
     }
   },
   "main_rust": {
     "description": "Generated main program Rust code: main.rs",
     "type": "string"
   },
   "output_connectors": {
     "description": "Output connectors derived from the schema.",
     "type": "object",
     "additionalProperties": {
       "$ref": "#/components/schemas/OutputEndpointConfig"
     }
   },
   "schema": {
     "description": "Schema of the compiled SQL."
   },
   "udf_stubs": {
     "description": "Generated user defined function (UDF) stubs Rust code: stubs.rs",
     "type": "string"
   }
 }
}

Fields

circuit_ir: Option<Value>

JIT circuit IR (allOperators) captured by the SQL compiler for Gen-2 programs; the Gen-2 engine reads it to build the circuit.

Not returned by the API. It runs to several MiB and reaches the pipeline through the program info artifact, so a pipeline read never carries it.

dataflow: Option<Dataflow>

input_connectors: HashMap<String, InputEndpointConfig>

Input connectors derived from the schema.

main_rust: Option<String>

Generated main program Rust code: main.rs

output_connectors: HashMap<String, OutputEndpointConfig>

Output connectors derived from the schema.

schema: Value

Schema of the compiled SQL.

udf_stubs: Option<String>

Generated user defined function (UDF) stubs Rust code: stubs.rs

Implementations

impl ProgramInfo

pub fn builder() -> ProgramInfo

Trait Implementations

impl Clone for ProgramInfo

fn clone(&self) -> ProgramInfo

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ProgramInfo

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProgramInfo

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&ProgramInfo> for ProgramInfo

fn from(value: &ProgramInfo) -> Self

Converts to this type from the input type.

impl From<ProgramInfo> for ProgramInfo

fn from(value: ProgramInfo) -> Self

Converts to this type from the input type.

impl Serialize for ProgramInfo

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<ProgramInfo> for ProgramInfo

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: ProgramInfo) -> Result<Self, ConversionError>

Performs the conversion.