API reference
Auto-generated reference for the public exports of @spark-connect-js/core
and @spark-connect-js/node. Each entry below is sourced from the TSDoc on
the corresponding source symbol; this page is a directory, not a tutorial.
For task-oriented usage, start with the Quickstart and the SQL and DataFrame guide. For the layered model behind the types listed here (logical plans, transport, Arrow decoding), see Architecture.
Enumerations
Section titled “Enumerations”Classes
Section titled “Classes”- Catalog
- Column
- DataFrame
- DataFrameReader
- DataFrameStat
- DataFrameWriter
- DataFrameWriterV2
- GroupedData
- InvalidConfigError
- InvalidInputError
- PlanBuilder
- RuntimeConfig
- SparkClientError
- SparkConnectError
- SparkSession
- SparkSessionBuilder
- StructField
- StructType
- UDFRegistration
- UnsupportedOperationError
- WhenBuilder
- WindowSpec
Interfaces
Section titled “Interfaces”- AggregatePlan
- CatalogPlan
- DeduplicatePlan
- DescribePlan
- DropPlan
- ExecuteOptions
- FieldDescriptor
- FilterPlan
- HintPlan
- JoinPlan
- LimitPlan
- LocalRelationPlan
- NADropPlan
- NAFillPlan
- NAReplacePlan
- OffsetPlan
- ProjectPlan
- RangePlan
- ReadPlan
- ReadTablePlan
- RepartitionByExpressionPlan
- RepartitionPlan
- SamplePlan
- Schema
- SetOperationPlan
- SortOrder
- SortPlan
- SparkSessionConfig
- SqlPlan
- StatApproxQuantilePlan
- StatCorrPlan
- StatCovPlan
- StatCrosstabPlan
- StatFreqItemsPlan
- StorageLevel
- SubqueryAliasPlan
- SummaryPlan
- TailPlan
- ToDFPlan
- Transport
- UnpivotPlan
- WindowFrame
- WithColumnsPlan
- WithColumnsRenamedPlan
Type Aliases
Section titled “Type Aliases”Variables
Section titled “Variables”- character_length
- date_part
- DISK_ONLY
- DISK_ONLY_2
- every
- first_value
- getbit
- GrpcStatusCode
- last_value
- mean
- MEMORY_AND_DISK
- MEMORY_AND_DISK_2
- MEMORY_AND_DISK_SER
- MEMORY_AND_DISK_SER_2
- MEMORY_ONLY
- MEMORY_ONLY_2
- MEMORY_ONLY_SER
- MEMORY_ONLY_SER_2
- negative
- nvl
- OFF_HEAP
- sign
- some
- StorageLevel_NONE
- variance
- Window
Functions
Section titled “Functions”- abs
- acos
- add_months
- any_value
- approx_count_distinct
- array
- array_agg
- array_compact
- array_contains
- array_distinct
- array_except
- array_intersect
- array_join
- array_max
- array_min
- array_position
- array_remove
- array_repeat
- array_sort
- array_union
- arrays_overlap
- arrays_zip
- asc
- asc_nulls_first
- asc_nulls_last
- ascii
- asin
- atan
- atan2
- avg
- base64
- bin
- bit_and
- bit_count
- bit_get
- bit_length
- bit_or
- bit_xor
- bitwise_not
- bool_and
- bool_or
- broadcast
- bround
- btrim
- cast
- cbrt
- ceil
- char_length
- coalesce
- col
- collect_list
- collect_set
- concat
- concat_ws
- contains
- corr
- cos
- cosh
- count
- count_if
- countDistinct
- covar_pop
- covar_samp
- crc32
- create_map
- cume_dist
- current_date
- current_timestamp
- date_add
- date_format
- date_sub
- date_trunc
- datediff
- dayofmonth
- dayofweek
- dayofyear
- decode
- degrees
- dense_rank
- desc
- desc_nulls_first
- desc_nulls_last
- e
- element_at
- encode
- endswith
- exp
- explode
- explode_outer
- expm1
- expr
- extract
- factorial
- first
- flatten
- floor
- format_number
- format_string
- from_csv
- from_json
- from_unixtime
- get
- get_json_object
- greatest
- grouping
- grouping_id
- hash
- hex
- hour
- hypot
- ifnull
- initcap
- inline
- inline_outer
- instr
- isnan
- isnotnull
- isnull
- json_array_length
- json_object_keys
- json_tuple
- kurtosis
- lag
- last
- last_day
- lead
- least
- left
- length
- levenshtein
- lit
- locate
- log
- log10
- log1p
- log2
- lower
- lpad
- ltrim
- map_concat
- map_entries
- map_from_arrays
- map_from_entries
- map_keys
- map_values
- max
- max_by
- md5
- median
- min
- min_by
- minute
- mode
- monotonically_increasing_id
- month
- months_between
- nanvl
- negate
- next_day
- nth_value
- ntile
- nullif
- nvl2
- octet_length
- overlay
- percent_rank
- percentile_approx
- pi
- pmod
- posexplode
- posexplode_outer
- positive
- pow
- product
- quarter
- radians
- rand
- randn
- rank
- regexp_replace
- repeat
- reverse
- right
- rint
- round
- row_number
- rpad
- rtrim
- schema_of_csv
- schema_of_json
- second
- sequence
- sha1
- sha2
- shiftleft
- shiftright
- shiftrightunsigned
- signum
- sin
- sinh
- size
- skewness
- slice
- sort_array
- soundex
- spark_partition_id
- split
- sqrt
- stack
- startswith
- stddev
- stddev_pop
- stddev_samp
- struct
- substring
- sum
- sum_distinct
- tan
- tanh
- to_csv
- to_date
- to_json
- to_timestamp
- translate
- trim
- trunc
- typeof_
- unbase64
- unhex
- unix_timestamp
- upper
- uuid
- var_pop
- var_samp
- weekofyear
- when
- xxhash64
- year
References
Section titled “References”GrpcStatusCodeType
Section titled “GrpcStatusCodeType”Renames and re-exports GrpcStatusCode