Skip to main content

ReduceSpec

Struct ReduceSpec 

Source
pub struct ReduceSpec { /* private fields */ }
Expand description

A reduce operation over already-sorted input.

Every input table must already be sorted by a column set that starts with reduce_bySortSpec is how a table gets that way. When it is, this is the operation to reach for: a map-reduce over the same data would pay for a shuffle that has already been done.

use ytsaurus_client::ReduceSpec;

let spec = ReduceSpec::new("./wordcount reduce", ["//tmp/sorted"], ["//tmp/counts"], ["word"])
    .with_local_file("//tmp/wordcount");

Implementations§

Source§

impl ReduceSpec

Source

pub fn new<I, O, K>( command: impl Into<String>, inputs: I, outputs: O, reduce_by: K, ) -> Self

A reduce running command over inputs, grouped by reduce_by.

Source

pub fn with_local_file(self, path: impl Into<String>) -> Self

Adds a Cypress file the job needs — normally the worker binary.

Source

pub fn with_local_file_named( self, path: impl Into<String>, name: impl AsRef<str>, ) -> Self

Adds a Cypress file under a different name in the job’s sandbox.

See MapSpec::with_local_file_named for why the name matters.

Source

pub fn with_memory_limit(self, bytes: i64) -> Self

Sets the reducer’s memory limit, in bytes.

Source

pub fn with_formats(self, input: DataFormat, output: DataFormat) -> Self

Selects the reducer’s input and output data formats.

YSON selections apply to every table. A Skiff selection must contain one table schema per corresponding input or output table, in the same order. The default remains binary YSON.

A Skiff reducer receives its key switch as a $key_switch boolean column rather than as a YSON control record, so the input schema has to declare that column for ytsaurus-job’s SkiffJobReader to report it — enable_key_switch asks the cluster to deliver key switches, and the format decides how they arrive. A schema without the column leaves a grouping reducer seeing one group, exactly as Self::without_key_switch would.

Source

pub fn with_skiff_formats(self, input: SkiffFormat, output: SkiffFormat) -> Self

Uses validated Skiff formats for the reducer’s input and output streams.

This compatibility convenience delegates to Self::with_formats.

Source

pub fn with_env(self, key: impl Into<String>, value: impl Into<String>) -> Self

Sets an environment variable for the job, e.g. RUST_BACKTRACE.

Source

pub fn with_sort_by<K>(self, columns: K) -> Self
where K: IntoIterator, K::Item: Into<String>,

Sets the columns the input is sorted by, when they differ from reduce_by.

reduce_by must be a prefix of them. Saying so asks the cluster to check the input really is sorted that way, and guarantees the order rows arrive in within a group.

Source

pub fn with_job_count(self, count: i64) -> Self

Requests a specific job count.

Source

pub fn with_input_table_index(self) -> Self

Asks for the input table index to be delivered with each row.

Reduce merges several sorted tables into one stream, so this is how a job tells which table a row came from.

Source

pub fn without_key_switch(self) -> Self

Turns off key_switch delivery to the reducer.

Source

pub fn skiff_table_mismatch(&self) -> Option<String>

Describes a Skiff format that does not match this spec’s table lists.

A reduce merges its input tables into one sorted stream but keeps them distinguishable, so the input format describes every input table, as the Go SDK’s setupSkiffInputFormat also requires. See MapSpec::skiff_table_mismatch for what an unchecked mismatch costs. Client::start_reduce checks this before sending the spec.

Source

pub fn with_raw(self, key: impl Into<String>, value: YsonValue) -> Self

Sets any spec field this builder does not model.

Source

pub fn to_yson(&self) -> YsonValue

Renders the spec.

Trait Implementations§

Source§

impl Clone for ReduceSpec

Source§

fn clone(&self) -> ReduceSpec

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ReduceSpec

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more