org.elasticsearch.xpack.esql.package-info Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of x-pack-esql Show documentation

The plugin that powers ESQL for Elasticsearch

There is a newer version: 8.16.1

/*
 * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
 * or more contributor license agreements. Licensed under the Elastic License
 * 2.0; you may not use this file except in compliance with the Elastic License
 * 2.0.
 */

/**
 * ES|QL Overview and Documentation Links
 *
 * Major Components
 * 
 * {@link org.elasticsearch.compute} - The compute engine drives query execution
 * 
 *     {@link org.elasticsearch.compute.data.Block} - fundamental unit of data.  Operations vectorize over blocks.
 *     {@link org.elasticsearch.compute.data.Page} - Data is broken up into pages (which are collections of blocks) to
 *     manage size in memory
 * 
 * 
 * {@link org.elasticsearch.xpack.esql.core} - Core Utility Classes
 * 
 *     {@link org.elasticsearch.xpack.esql.core.type.DataType} - ES|QL is a typed language, and all the supported data types
 *     are listed in this collection.
 *     {@link org.elasticsearch.xpack.esql.core.expression.Expression} - Expression is the basis for all functions in ES|QL,
 *     but see also {@link org.elasticsearch.xpack.esql.evaluator.mapper.EvaluatorMapper}
 * 
 * 
 *  org.elasticsearch.compute.gen - ES|QL generates code for evaluators, which are type-specific implementations of
 * functions, designed to run over a {@link org.elasticsearch.compute.data.Block} 
 * {@link org.elasticsearch.xpack.esql.session.EsqlSession} - manages state across a query
 * {@link org.elasticsearch.xpack.esql.expression.function.scalar} - Guide to writing scalar functions
 * {@link org.elasticsearch.xpack.esql.expression.function.aggregate} - Guide to writing aggregation functions
 * {@link org.elasticsearch.xpack.esql.analysis.Analyzer} - The first step in query processing
 * {@link org.elasticsearch.xpack.esql.optimizer.LogicalPlanOptimizer} - Coordinator level logical optimizations
 * {@link org.elasticsearch.xpack.esql.optimizer.LocalLogicalPlanOptimizer} - Data node level logical optimizations
 * {@link org.elasticsearch.xpack.esql.action.RestEsqlQueryAction} - REST API entry point
 * 
 */

package org.elasticsearch.xpack.esql;