Skip to main content

RuntimeConf

Struct RuntimeConf 

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

Runtime configuration for a Spark session.

Allows getting and setting runtime configuration parameters on the Spark server. Mirrors pyspark.sql.conf.RuntimeConfig.

Implementations§

Source§

impl RuntimeConf

Source

pub fn set(&self, key: &str, value: &str) -> Result<()>

Set a configuration key-value pair.

Converts boolean and integer values to strings as required by the server.

§Arguments
  • key - The configuration key (e.g., “spark.sql.shuffle.partitions”)
  • value - The configuration value as a string, integer, or boolean
§Example
conf.set("spark.sql.shuffle.partitions", "200")?;
conf.set("spark.sql.adaptive.enabled", true)?;
conf.set("spark.sql.maxMetadataStringLength", 100)?;
Source

pub fn get(&self, key: &str) -> Result<Option<String>>

Get a configuration value by key.

Returns Ok(None) if the key does not exist on the server.

§Arguments
  • key - The configuration key to retrieve
§Example
let value = conf.get("spark.sql.shuffle.partitions")?;
println!("Shuffle partitions: {:?}", value);
Source

pub fn get_with_default( &self, key: &str, default: Option<&str>, ) -> Result<Option<String>>

Get a configuration value, returning default when the key is unset — instead of erroring as get does for an unknown key. Uses the server’s GetWithDefault operation, mirroring RuntimeConfig.get(key, default).

Source

pub fn get_all(&self) -> Result<HashMap<String, String>>

Get all configuration values as a HashMap.

§Example
let all_configs = conf.get_all()?;
for (key, value) in all_configs.iter() {
    println!("{}: {}", key, value);
}
Source

pub fn unset(&self, key: &str) -> Result<()>

Unset a configuration key (reset to default).

§Arguments
  • key - The configuration key to unset
§Example
conf.unset("spark.sql.shuffle.partitions")?;
Source

pub fn is_modifiable(&self, key: &str) -> Result<bool>

Check if a configuration key is modifiable.

Returns true if the configuration can be changed at runtime, false if it’s read-only or cannot be modified.

§Arguments
  • key - The configuration key to check
§Example
if conf.is_modifiable("spark.sql.shuffle.partitions")? {
    println!("This config can be modified");
}

Trait Implementations§

Source§

impl Clone for RuntimeConf

Source§

fn clone(&self) -> Self

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

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

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

fn try_from(value: U) -> Result<T, !>

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