Introduction
BigGeo Search is a Geospatial Search Index that enables your geospatial data, allowing you to build the solutions you want, with the speed you need. BigGeo allows you to easily communicate with large geospatial datasets of various different geometry types.
The BigGeo API is your gateway to harnessing the power of geospatial searches. This comprehensive guide will walk you through the process of utilizing the BigGeo API effectively.
To get started with the BigGeo API, your first step is deploying your very own instance of BigGeo. This documentation will provide step-by-step instructions on how to set up and communicate with your deployed instance, ensuring a seamless experience in leveraging the full potential of BigGeo.
Protocol
The BigGeo API utilizes the gRPC protocol, a robust communication framework. This protocol is the backbone of your interactions with BigGeo, enabling efficient data exchange and powerful containerized searches. For more detailed information on gRPC, please refer to the gRPC documentation.
Endpoints
| Endpoint | Description |
|---|---|
| Create Collection | Creates a collection. |
| Remove Collection | Removes a collection. |
| Get Collection Info | Retrieves a collection's information. |
| Swap Collections | Swaps two collection's contents. |
| Rename Collection | Renames a collection. |
| Save Collection To File | Saves a collection to file. |
| Load Collection From File | Loads a collection from file. |
| Insert | Inserts a geometry into a collection. |
| Update | Update a geometry in a collection. |
| Upsert | Upsert a geometry in a collection (updates if already inserted or inserts if not present). |
| Remove | Removes a geometry from a collection. |
| Search Intersects | Provided a geometry, searches for intersecting geometries within a collection. |
| Search Dist Within | Searches for geometries within a provided distance of a geometry. |
| Write To Collection | Write a set of operations to a collection. |