API

This page introduces the user interfaces provided by the Pegasus service. Clients can build secondary wrappers on top of these service interfaces. In most cases, you only need to learn how to interact with Pegasus via the Client Documentation.

Pegasus currently supports several interface protocols:

Pegasus Protocol

This is the protocol used by our clients to interact with Pegasus servers. Through this protocol we expose:

  • Single-row idempotent atomic operations, such as set/get/del/ttl…
  • Single-row non-idempotent atomic operations, such as check_and_mutate/incr…
  • Multi-row idempotent atomic operations, such as multiset/multiget/multidel…
  • Scan operations with filtering, such as hash_scan/unordered_scan…

Redis Protocol

We support the Redis protocol on top of the Pegasus protocol via the Pegasus Redis Proxy component. You can read Redis Adaptation to learn more.

Since the Redis interface provides GEO support, we also support geospatial query capabilities through it. You can read GEO Support to learn more.

Copyright © 2023 The Apache Software Foundation. Licensed under the Apache License, Version 2.0.

Apache Pegasus is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.

Apache Pegasus, Pegasus, Apache, the Apache feather logo, and the Apache Pegasus project logo are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries.

Table of contents