📚 gatewayd - Awesome Go Library for Database

Like API gateways, for databases

Cloud-native database gateway and framework for building data-driven applications.

GatewayD is a free and open-source cloud-native database gateway and framework for building data-driven applications. It is a middleware that sits between your database servers and clients and proxies all their communication. It is like API gateways in system design, but instead is used for proxying database traffic, rather than HTTP traffic.

GatewayD is an L4 proxy for SQL, and eventually NoSQL, databases and clients. The core is database-protocol-agnotic, and the plugins encode, decode and add value to the database traffic flow, hence it can technically support all databases. You can either write your own plugins or make use of our built-in, community and enterprise plugins.

Using GatewayD, you can see through the queries and the data passing between your database server and clients, and take action. For example, you can cache the result of SQL SELECT queries or detect and prevent SQL injection attacks.

GatewayD is developed by GatewayD Labs and the community.

Features

• Cloud-native:

  Built with cloud-native principles in mind: containerized, stateless, observable and extensible, while being secure and reliable.

• Connection pooling and proxying:

  Pools connections to database servers and clients and proxies them together.

• Database-agnostic:

  GatewayD proxies connections, while plugins enable database support.

• Plugin-based & extensible:

  Plugins extend functionality. You can write your own plugins or use our built-in, community and enterprise plugins.

• Multi-tenancy:

  Manage multiple databases and clients within a single GatewayD instance.

• Full observability:

  Integrated logging, metrics, and tracing for comprehensive monitoring and observability.

Plugins & SDK

The plugins are the lifeblood of GatewayD. They are loaded on startup to add tons of functionality, for example:

• Query parsing and processing
• Authentication, authorization and access management
• Caching
• Injection detection and prevention
• Firewalling
• Query, schema and data management and transformation
• Change data capture
• Distributed query processing
• Many other possibilities

The plugins are usually written in Go and are compiled into stand-alone executables. They are loaded on startup and are ready to be used by the users. In turn, the developers can write their own plugins and use them in their applications, which is made possible by using the SDK.

Documentation

The docs cover all aspects of using GatewayD. Some highlights include:

• Getting Started: install, run an instance of GatewayD and test it in action.
• Configuration: learn how you can configure GatewayD to behave as you like.
  • Global Configuration: control GatewayD's behavior.
  • Plugins Configuration: control GatewayD's plugin registry and the plugins' behavior.
• Observability: logs, metrics, and traces are GatewayD's first-class citizens.
• Using Plugins: learn how to use plugins.
• Developing Plugins: learn how to develop your own plugins.
• gatewayd-plugin-cache: learn how to use the gatewayd-plugin-cache plugin for caching queries and their results.
• gatewayd-plugin-js: learn how to use the experimental gatewayd-plugin-js plugin for executing JavaScript code in GatewayD.

Contributing

We welcome contributions from everyone. Just open an issue or send us a pull request.

License

GatewayD is licensed under the Affero General Public License v3.0.