Struct polars_io::json::JsonReader

source ·
pub struct JsonReader<'a, R>
where R: MmapBytesReader,
{ /* private fields */ }
Available on crate feature json only.
Expand description

Reads JSON in one of the formats in JsonFormat into a DataFrame.

Implementations§

source§

impl<'a, R> JsonReader<'a, R>
where R: MmapBytesReader,

source

pub fn with_schema(self, schema: SchemaRef) -> Self

Set the JSON file’s schema

source

pub fn with_schema_overwrite(self, schema: &'a Schema) -> Self

Overwrite parts of the inferred schema.

source

pub fn infer_schema_len(self, max_records: Option<usize>) -> Self

Set the JSON reader to infer the schema of the file. Currently, this is only used when reading from JsonFormat::JsonLines, as JsonFormat::Json reads in the entire array anyway.

When using JsonFormat::JsonLines, max_records = None will read the entire buffer in order to infer the schema, Some(1) would look only at the first record, Some(2) the first two records, etc.

It is an error to pass max_records = Some(0), as a schema cannot be inferred from 0 records when deserializing from JSON (unlike CSVs, there is no header row to inspect for column names).

source

pub fn with_batch_size(self, batch_size: NonZeroUsize) -> Self

Set the batch size (number of records to load at one time)

This heavily influences loading time.

source

pub fn with_projection(self, projection: Option<Vec<String>>) -> Self

Set the reader’s column projection: the names of the columns to keep after deserialization. If None, all columns are kept.

Setting projection to the columns you want to keep is more efficient than deserializing all of the columns and then dropping the ones you don’t want.

source

pub fn with_json_format(self, format: JsonFormat) -> Self

source

pub fn with_ignore_errors(self, ignore: bool) -> Self

Return a null if an error occurs during parsing.

Trait Implementations§

source§

impl<'a, R> SerReader<R> for JsonReader<'a, R>
where R: MmapBytesReader,

source§

fn finish(self) -> PolarsResult<DataFrame>

Take the SerReader and return a parsed DataFrame.

Because JSON values specify their types (number, string, etc), no upcasting or conversion is performed between incompatible types in the input. In the event that a column contains mixed dtypes, is it unspecified whether an error is returned or whether elements of incompatible dtypes are replaced with null.

source§

fn new(reader: R) -> Self

Create a new instance of the [SerReader]
source§

fn set_rechunk(self, rechunk: bool) -> Self

Make sure that all columns are contiguous in memory by aggregating the chunks into a single array.

Auto Trait Implementations§

§

impl<'a, R> Freeze for JsonReader<'a, R>
where R: Freeze,

§

impl<'a, R> !RefUnwindSafe for JsonReader<'a, R>

§

impl<'a, R> Send for JsonReader<'a, R>

§

impl<'a, R> Sync for JsonReader<'a, R>

§

impl<'a, R> Unpin for JsonReader<'a, R>
where R: Unpin,

§

impl<'a, R> !UnwindSafe for JsonReader<'a, R>

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> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

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

§

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>,

§

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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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