blob: 55c7a1613e9c6da6831ec606ee69f047061d3139 [file] [log] [blame] [view]
---
{
"title": "ST_CIRCLE",
"language": "en"
}
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
## Description
Convert a WKT (Well Known Text) to a circle on the sphere of the Earth.
## Syntax
```sql
ST_CIRCLE( <center_lng>, <center_lat>, <radius>)
```
## Parameters
| Parameters | Instructions |
| -- | -- |
| `<center_lng>` | Longitude of the center of the circle |
| `<center_lat>` | The latitude of the center of the circle |
| `<radius>` | Radius of a circle |
- The unit of radius is meters. A maximum of 9999999 RADIUS is supported
## Return Value
A circle on a sphere based on basic information about the circle
## Examples
```sql
SELECT ST_AsText(ST_Circle(111, 64, 10000));
```
```text
+--------------------------------------------+
| st_astext(st_circle(111.0, 64.0, 10000.0)) |
+--------------------------------------------+
| CIRCLE ((111 64), 10000) |
+--------------------------------------------+
```