> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-8c05c8a2.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Functions for Working with S2 Index

> Documentation for functions for working with S2 indexes

<h2 id="s2index">
  S2Index
</h2>

[S2](https://s2geometry.io/) is a geographical indexing system where all geographical data is represented on a sphere (similar to a globe).

In the S2 library points are represented as the S2 Index - a specific number which encodes internally a point on the surface of a unit sphere, unlike traditional (latitude, longitude) pairs. To get the S2 point index for a given point specified in the format (latitude, longitude) use the [geoToS2](#geotos2) function. Also, you can use the [s2ToGeo](#s2togeo) function for getting geographical coordinates corresponding to the specified S2 point index.

<h2 id="geotos2">
  geoToS2
</h2>

Returns [S2](#s2index) point index corresponding to the provided coordinates `(longitude, latitude)`.

**Syntax**

```sql theme={null}
geoToS2(lon, lat)
```

**Arguments**

* `lon` — Longitude. [Float64](/reference/data-types/float).
* `lat` — Latitude. [Float64](/reference/data-types/float).

**Returned values**

* S2 point index. [UInt64](/reference/data-types/int-uint).

**Example**

```sql title="Query" theme={null}
SELECT geoToS2(37.79506683, 55.71290588) AS s2Index;
```

```text title="Response" theme={null}
┌─────────────s2Index─┐
│ 4704772434919038107 │
└─────────────────────┘
```

<h2 id="s2togeo">
  s2ToGeo
</h2>

Returns geo coordinates `(longitude, latitude)` corresponding to the provided [S2](#s2index) point index.

**Syntax**

```sql theme={null}
s2ToGeo(s2index)
```

**Arguments**

* `s2index` — S2 Index. [UInt64](/reference/data-types/int-uint).

**Returned values**

* A [tuple](/reference/data-types/tuple) consisting of two values:
  * `lon`. [Float64](/reference/data-types/float).
  * `lat`. [Float64](/reference/data-types/float).

**Example**

```sql title="Query" theme={null}
SELECT s2ToGeo(4704772434919038107) AS s2Coodrinates;
```

```text title="Response" theme={null}
┌─s2Coodrinates────────────────────────┐
│ (37.79506681471008,55.7129059052841) │
└──────────────────────────────────────┘
```

<h2 id="s2getneighbors">
  s2GetNeighbors
</h2>

Returns S2 neighbor indexes corresponding to the provided [S2](#s2index). Each cell in the S2 system is a quadrilateral bounded by four geodesics. So, each cell has 4 neighbors.

**Syntax**

```sql theme={null}
s2GetNeighbors(s2index)
```

**Arguments**

* `s2index` — S2 Index. [UInt64](/reference/data-types/int-uint).

**Returned value**

* An array consisting of 4 neighbor indexes: `array[s2index1, s2index3, s2index2, s2index4]`. [Array](/reference/data-types/array)([UInt64](/reference/data-types/int-uint)).

**Example**

```sql title="Query" theme={null}
SELECT s2GetNeighbors(5074766849661468672) AS s2Neighbors;
```

```text title="Response" theme={null}
┌─s2Neighbors───────────────────────────────────────────────────────────────────────┐
│ [5074766987100422144,5074766712222515200,5074767536856236032,5074767261978329088] │
└───────────────────────────────────────────────────────────────────────────────────┘
```

<h2 id="s2cellsintersect">
  s2CellsIntersect
</h2>

Determines if the two provided [S2](#s2index) cells intersect or not.

**Syntax**

```sql theme={null}
s2CellsIntersect(s2index1, s2index2)
```

**Arguments**

* `siIndex1`, `s2index2` — S2 Index. [UInt64](/reference/data-types/int-uint).

**Returned value**

* `1` — If the cells intersect. [UInt8](/reference/data-types/int-uint).
* `0` — If the cells don't intersect. [UInt8](/reference/data-types/int-uint).

**Example**

```sql title="Query" theme={null}
SELECT s2CellsIntersect(9926595209846587392, 9926594385212866560) AS intersect;
```

```text title="Response" theme={null}
┌─intersect─┐
│         1 │
└───────────┘
```

<h2 id="s2capcontains">
  s2CapContains
</h2>

Determines if a cap contains a S2 point. A cap represents a part of the sphere that has been cut off by a plane. It is defined by a point on a sphere and a radius in degrees.

**Syntax**

```sql theme={null}
s2CapContains(center, degrees, point)
```

**Arguments**

* `center` — S2 point index corresponding to the cap. [UInt64](/reference/data-types/int-uint).
* `degrees` — Radius of the cap in degrees. [Float64](/reference/data-types/float).
* `point` — S2 point index. [UInt64](/reference/data-types/int-uint).

**Returned value**

* `1` — If the cap contains the S2 point index. [UInt8](/reference/data-types/int-uint).
* `0` — If the cap doesn't contain the S2 point index. [UInt8](/reference/data-types/int-uint).

**Example**

```sql title="Query" theme={null}
SELECT s2CapContains(1157339245694594829, 1.0, 1157347770437378819) AS capContains;
```

```text title="Response" theme={null}
┌─capContains─┐
│           1 │
└─────────────┘
```

<h2 id="s2capunion">
  s2CapUnion
</h2>

Determines the smallest cap that contains the given two input caps. A cap represents a portion of the sphere that has been cut off by a plane. It is defined by a point on a sphere and a radius in degrees.

**Syntax**

```sql theme={null}
s2CapUnion(center1, radius1, center2, radius2)
```

**Arguments**

* `center1`, `center2` — S2 point indexes corresponding to the two input caps. [UInt64](/reference/data-types/int-uint).
* `radius1`, `radius2` — Radius of the two input caps in degrees. [Float64](/reference/data-types/float).

**Returned values**

* `center` — S2 point index corresponding the center of the smallest cap containing the two input caps. [UInt64](/reference/data-types/int-uint).
* `radius` — Radius of the smallest cap containing the two input caps. [Float64](/reference/data-types/float).

**Example**

```sql title="Query" theme={null}
SELECT s2CapUnion(3814912406305146967, 1.0, 1157347770437378819, 1.0) AS capUnion;
```

```text title="Response" theme={null}
┌─capUnion───────────────────────────────┐
│ (4534655147792050737,60.2088283994957) │
└────────────────────────────────────────┘
```

<h2 id="s2rectadd">
  s2RectAdd
</h2>

Increases the size of the bounding rectangle to include the given S2 point. In the S2 system, a rectangle is represented by a type of S2Region called a `S2LatLngRect` that represents a rectangle in latitude-longitude space.

**Syntax**

```sql theme={null}
s2RectAdd(s2pointLow, s2pointHigh, s2Point)
```

**Arguments**

* `s2PointLow` — Low S2 point index corresponding to the rectangle. [UInt64](/reference/data-types/int-uint).
* `s2PointHigh` — High S2 point index corresponding to the rectangle. [UInt64](/reference/data-types/int-uint).
* `s2Point` — Target S2 point index that the bound rectangle should be grown to include. [UInt64](/reference/data-types/int-uint).

**Returned values**

* `s2PointLow` — Low S2 cell id corresponding to the grown rectangle. [UInt64](/reference/data-types/int-uint).
* `s2PointHigh` — Height S2 cell id corresponding to the grown rectangle. [UInt64](/reference/data-types/float).

**Example**

```sql title="Query" theme={null}
SELECT s2RectAdd(5178914411069187297, 5177056748191934217, 5179056748191934217) AS rectAdd;
```

```text title="Response" theme={null}
┌─rectAdd───────────────────────────────────┐
│ (5179062030687166815,5177056748191934217) │
└───────────────────────────────────────────┘
```

<h2 id="s2rectcontains">
  s2RectContains
</h2>

Determines if a given rectangle contains a S2 point. In the S2 system, a rectangle is represented by a type of S2Region called a `S2LatLngRect` that represents a rectangle in latitude-longitude space.

**Syntax**

```sql theme={null}
s2RectContains(s2PointLow, s2PointHi, s2Point)
```

**Arguments**

* `s2PointLow` — Low S2 point index corresponding to the rectangle. [UInt64](/reference/data-types/int-uint).
* `s2PointHigh` — High S2 point index corresponding to the rectangle. [UInt64](/reference/data-types/int-uint).
* `s2Point` — Target S2 point index. [UInt64](/reference/data-types/int-uint).

**Returned value**

* `1` — If the rectangle contains the given S2 point.
* `0` — If the rectangle doesn't contain the given S2 point.

**Example**

```sql title="Query" theme={null}
SELECT s2RectContains(5179062030687166815, 5177056748191934217, 5177914411069187297) AS rectContains;
```

```text title="Response" theme={null}
┌─rectContains─┐
│            0 │
└──────────────┘
```

<h2 id="s2rectunion">
  s2RectUnion
</h2>

Returns the smallest rectangle containing the union of this rectangle and the given rectangle. In the S2 system, a rectangle is represented by a type of S2Region called a `S2LatLngRect` that represents a rectangle in latitude-longitude space.

**Syntax**

```sql theme={null}
s2RectUnion(s2Rect1PointLow, s2Rect1PointHi, s2Rect2PointLow, s2Rect2PointHi)
```

**Arguments**

* `s2Rect1PointLow`, `s2Rect1PointHi` — Low and High S2 point indexes corresponding to the first rectangle. [UInt64](/reference/data-types/int-uint).
* `s2Rect2PointLow`, `s2Rect2PointHi` — Low and High S2 point indexes corresponding to the second rectangle. [UInt64](/reference/data-types/int-uint).

**Returned values**

* `s2UnionRect2PointLow` — Low S2 cell id corresponding to the union rectangle. [UInt64](/reference/data-types/int-uint).
* `s2UnionRect2PointHi` — High S2 cell id corresponding to the union rectangle. [UInt64](/reference/data-types/int-uint).

**Example**

```sql title="Query" theme={null}
SELECT s2RectUnion(5178914411069187297, 5177056748191934217, 5179062030687166815, 5177056748191934217) AS rectUnion;
```

```text title="Response" theme={null}
┌─rectUnion─────────────────────────────────┐
│ (5179062030687166815,5177056748191934217) │
└───────────────────────────────────────────┘
```

<h2 id="s2rectintersection">
  s2RectIntersection
</h2>

Returns the smallest rectangle containing the intersection of this rectangle and the given rectangle. In the S2 system, a rectangle is represented by a type of S2Region called a `S2LatLngRect` that represents a rectangle in latitude-longitude space.

**Syntax**

```sql theme={null}
s2RectIntersection(s2Rect1PointLow, s2Rect1PointHi, s2Rect2PointLow, s2Rect2PointHi)
```

**Arguments**

* `s2Rect1PointLow`, `s2Rect1PointHi` — Low and High S2 point indexes corresponding to the first rectangle. [UInt64](/reference/data-types/int-uint).
* `s2Rect2PointLow`, `s2Rect2PointHi` — Low and High S2 point indexes corresponding to the second rectangle. [UInt64](/reference/data-types/int-uint).

**Returned values**

* `s2UnionRect2PointLow` — Low S2 cell id corresponding to the rectangle containing the intersection of the given rectangles. [UInt64](/reference/data-types/int-uint).
* `s2UnionRect2PointHi` — High S2 cell id corresponding to the rectangle containing the intersection of the given rectangles. [UInt64](/reference/data-types/int-uint).

**Example**

```sql title="Query" theme={null}
SELECT s2RectIntersection(5178914411069187297, 5177056748191934217, 5179062030687166815, 5177056748191934217) AS rectIntersection;
```

```text title="Response" theme={null}
┌─rectIntersection──────────────────────────┐
│ (5178914411069187297,5177056748191934217) │
└───────────────────────────────────────────┘
```