package
35.0.0-20241101153557-77eb4bb6fff8
Repository: https://github.com/apache/spark-connect-go.git
Documentation: pkg.go.dev

# Functions

No description provided by the author
No description provided by the author

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Generates code for the statement, if any and a physical plan.
If plan node statistics are available, generates a logical plan and also the statistics.
Generates parsed logical plan, analyzed logical plan, optimized logical plan and physical plan.
Generates a physical plan outline and also node details.
Generates only physical plan.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
RangeFrame treats rows in a partition as groups of peers.
RowFrame treats rows in a partition individually.
No description provided by the author
Interrupt all running executions within the session with the provided session_id.
Interrupt the running execution within the session with the provided operation_id.
Interrupt all running executions within the session with the provided operation_tag.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

Enum value maps for Aggregate_GroupType.
Enum value maps for Aggregate_GroupType.
Enum value maps for AnalyzePlanRequest_Explain_ExplainMode.
Enum value maps for AnalyzePlanRequest_Explain_ExplainMode.
Enum value maps for Expression_SortOrder_NullOrdering.
Enum value maps for Expression_SortOrder_NullOrdering.
Enum value maps for Expression_SortOrder_SortDirection.
Enum value maps for Expression_SortOrder_SortDirection.
Enum value maps for Expression_Window_WindowFrame_FrameType.
Enum value maps for Expression_Window_WindowFrame_FrameType.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Enum value maps for InterruptRequest_InterruptType.
Enum value maps for InterruptRequest_InterruptType.
Enum value maps for Join_JoinType.
Enum value maps for Join_JoinType.
Enum value maps for Parse_ParseFormat.
Enum value maps for Parse_ParseFormat.
Enum value maps for SetOperation_SetOpType.
Enum value maps for SetOperation_SetOpType.
SparkConnectService_ServiceDesc is the grpc.ServiceDesc for SparkConnectService service.
Enum value maps for WriteOperation_SaveMode.
Enum value maps for WriteOperation_SaveMode.
Enum value maps for WriteOperation_SaveTable_TableSaveMethod.
Enum value maps for WriteOperation_SaveTable_TableSaveMethod.
Enum value maps for WriteOperationV2_Mode.
Enum value maps for WriteOperationV2_Mode.

# Structs

Request to transfer client-local artifacts.
A chunk of an Artifact.
A number of `SingleChunkArtifact` batched into a single RPC.
No description provided by the author
No description provided by the author
Signals the beginning/start of a chunked artifact.
No description provided by the author
An artifact that is contained in a single `ArtifactChunk`.
Response to adding an artifact.
Metadata of an artifact.
Relation of type [[Aggregate]].
No description provided by the author
Request to perform plan analyze, optionally to explain the plan.
No description provided by the author
No description provided by the author
Explains the input plan based on a configurable mode.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Returns `true` when the logical query plans are equal and therefore return same results.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Response to performing analysis of the query.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Request to get current statuses of artifacts at the server side.
Response to checking artifact statuses.
No description provided by the author
A local relation that has been cached already.
Represents a remote relation that has been cached on server.
See `spark.catalog.cacheTable`.
No description provided by the author
Catalog messages are marked as unstable.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
See `spark.catalog.clearCache`.
No description provided by the author
Collect arbitrary (named) metrics from a dataset.
A [[Command]] is an operation that is executed by the server that does not directly consume or produce a relational result.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Request to update or fetch the configurations.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Response to the config request.
A command that can create DataFrame global temp view or local temp view.
See `spark.catalog.createExternalTable`.
See `spark.catalog.createTable`.
See `spark.catalog.currentCatalog`.
See `spark.catalog.currentDatabase`.
See `spark.catalog.databaseExists`.
This message describes the logical [[DataType]] of something.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Start compound types.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Relation of type [[Deduplicate]] which have duplicate rows removed, could consider either only the subset of columns or all the columns.
Drop specified columns.
See `spark.catalog.dropGlobalTempView`.
See `spark.catalog.dropTempView`.
No description provided by the author
No description provided by the author
No description provided by the author
A request to be executed by the service.
No description provided by the author
No description provided by the author
No description provided by the author
The response of a query, can be one or more for each request.
Batch results of metrics.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A SQL command returns an opaque Relation that can be directly used as input for the next call.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Expression used to refer to fields, functions and similar.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Expression as string.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SortOrder is used to specify the data ordering, it is normally used in Sort and Window.
No description provided by the author
An unresolved attribute that is not explicitly bound to a specific column, but the column is resolved during analysis by name.
No description provided by the author
Extracts a value or values from an Expression.
No description provided by the author
An unresolved function is not explicitly bound to one explicit function, but the function is resolved during analysis following Sparks name resolution rules.
No description provided by the author
No description provided by the author
No description provided by the author
Represents all of the input attributes to a given relational operator, for example in "SELECT `(id)?+.+` FROM ...".
No description provided by the author
UnresolvedStar is used to expand all the fields of a relation or struct.
No description provided by the author
Add, replace or drop a field of `StructType` expression by name.
No description provided by the author
Expression for the OVER clause or WINDOW clause.
No description provided by the author
The window frame.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Relation that applies a boolean expression `condition` on each row of `input` to produce the output result.
See `spark.catalog.functionExists`.
See `spark.catalog.getDatabase`.
See `spark.catalog.getFunction`.
Command to get the output of 'SparkContext.resources'.
Response for command 'GetResourcesCommand'.
See `spark.catalog.getTable`.
No description provided by the author
Specify a hint over a relation.
Compose the string representing rows for output.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
See `spark.catalog.isCached`.
No description provided by the author
Relation of type [[Join]].
No description provided by the author
The key-value pair for the config request and response.
Relation of type [[Limit]] that is used to `limit` rows from the input relation.
See `spark.catalog.listCatalogs`.
See `spark.catalog.listColumns`.
See `spark.catalog.listDatabases`.
See `spark.catalog.listFunctions`.
See `spark.catalog.listTables`.
A relation that does not need to be qualified by name.
No description provided by the author
Drop rows containing null values.
Replaces null values.
Replaces old values with the corresponding values.
No description provided by the author
Relation of type [[Offset]] that is used to read rows staring from the `offset` on the input relation.
No description provided by the author
A [[Plan]] is the structure that carries the runtime information for the execution from the client to the server.
No description provided by the author
No description provided by the author
Projection of a bag of expressions for a given input relation.
No description provided by the author
No description provided by the author
Relation of type [[Range]] that generates a sequence of integers.
Relation that reads from a file / table or other data source.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
See `spark.catalog.recoverPartitions`.
See `spark.catalog.refreshByPath`.
See `spark.catalog.refreshTable`.
The main [[Relation]] type.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Common metadata of all relations.
No description provided by the author
Release and close operation completely.
No description provided by the author
Release all responses from the operation response stream up to and including the response with the given by response_id.
No description provided by the author
No description provided by the author
Relation repartition.
No description provided by the author
ResourceInformation to hold information about a type of Resource.
Relation of type [[Sample]] that samples a fraction of the dataset.
No description provided by the author
See `spark.catalog.setCurrentCatalog`.
See `spark.catalog.setCurrentDatabase`.
Relation of type [[SetOperation]].
Compose the string representing rows for output.
Relation of type [[Sort]].
Relation that uses a SQL query to generate the output.
A SQL Command is used to trigger the eager evaluation of SQL commands in Spark.
Calculates the approximate quantiles of numerical columns of a DataFrame.
Calculates the correlation of two columns of a DataFrame.
Calculate the sample covariance of two numerical columns of a DataFrame.
Computes a pair-wise frequency table of the given columns.
Computes basic statistics for numeric and string columns, including count, mean, stddev, min, and max.
Finding frequent items for columns, possibly with false positives.
Returns a stratified sample without replacement based on the fraction given on each stratum.
No description provided by the author
Computes specified statistics for numeric and string columns.
StorageLevel for persisting Datasets/Tables.
No description provided by the author
No description provided by the author
No description provided by the author
Commands for a streaming query.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Response for commands on a streaming query.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A tuple that uniquely identifies an instance of streaming query run.
Commands for the streaming query manager.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Response for commands on the streaming query manager.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Relation alias.
See `spark.catalog.tableExists`.
Relation of type [[Tail]] that is used to fetch `limit` rows from the last of the input relation.
Rename columns on the input relation by the same length of names.
No description provided by the author
See `spark.catalog.uncacheTable`.
UnimplementedSparkConnectServiceServer must be embedded to have forward compatible implementations.
Used for testing purposes only.
Unpivot a DataFrame from wide format to long format, optionally leaving identifier columns set.
No description provided by the author
User Context is used to refer to one particular user session that is executing queries in the backend.
Adding columns or replacing the existing columns that have the same names.
Rename columns on the input relation by a map with name to name mapping.
No description provided by the author
As writes are not directly handled during analysis and planning, they are modeled as commands.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
As writes are not directly handled during analysis and planning, they are modeled as commands.
Starts write stream operation as streaming query.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Interfaces

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SparkConnectServiceClient is the client API for SparkConnectService service.
SparkConnectServiceServer is the server API for SparkConnectService service.
UnsafeSparkConnectServiceServer may be embedded to opt out of forward compatibility for this service.

# Type aliases

No description provided by the author
Plan explanation mode.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author