plugin-sdk

module
v1.45.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 12, 2023 License: MPL-2.0

README

CloudQuery Plugin SDK

Go Reference Go Report Card Unit tests

CloudQuery SDK enables building CloudQuery source and destination plugins.

Source plugins allows developers to extract information from third party APIs and enjoying built-in transformations, concurrency, logging, testing and database agnostic support via destination plugins.

Destinations plugins allows writing the data from any of the source plugins to an additional database, message queue, storage or any other destination without recompiling any of the source plugins.

The plugin SDK is imported as a dependency by CloudQuery plugins. When starting a new plugin, you should use the Scaffold tool.

Getting Started & Documentation

Supported plugins

https://www.cloudquery.io/plugins

If you want us to add a new plugin or resource please open an Issue.

Directories

Path Synopsis
package clients is a wrapper around grpc clients so clients can work with non protobuf structs and handle unmarshaling
package clients is a wrapper around grpc clients so clients can work with non protobuf structs and handle unmarshaling
examples
simple_plugin Module
internal
pk
Package plugins defines APIs for source and destination plugins
Package plugins defines APIs for source and destination plugins
Package schema defines types supported by tables in source plugins
Package schema defines types supported by tables in source plugins
scripts
Package specs specs for source and destination plugins including parsers and readers.
Package specs specs for source and destination plugins including parsers and readers.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL