Code Monkey home page Code Monkey logo

go-fivetran's Introduction

Fivetran SDK for Go

Go Reference

go-fivetran is the official Fivetran SDK for the Go programming language.

Checkout our CHANGELOG for information about the latest bug fixes, updates, and features added to the SDK.

Make sure you read the Fivetran REST API documentation before using the SDK.

NOTE: go-fivetran is still in ALPHA development stage. Future versions may introduce breaking changes.

Installation

go get github.com/fivetran/go-fivetran

Importing

import (
    "github.com/fivetran/go-fivetran"
)

Getting started

Initialize a new Fivetran client:

	// get apiKey and apiSecret from environment variables
	apiKey := os.Getenv("FIVETRAN_APIKEY")
	apiSecret := os.Getenv("FIVETRAN_APISECRET")

	// initialize a new client
	client := fivetran.New(apiKey, apiSecret)

Each REST API endpoint has a service. Initialize a new Service:

	// initialize a new UsersList service
	svc := client.NewUsersList()

Call the API:

	// call the REST API
	resp, err := svc.Do(context.Background())
	if err != nil {
		...
	}

Or you can simply call API in chain style. Call Do() at the end to send an HTTP request to the REST API:

	resp, err := client.NewUsersList().
		Limit(3).
		Do(context.Background())

Examples

You can find examples for all services in the examples directory.

API List

The following Fivetran REST API endpoints are implemented by the Fivetran SDK for Go:

REST API Endpoint REST API Version SDK Service
List all Users v1 UsersListService
Retrieve user details v1 UserDetailsService
Invite a user v1 UserInviteService
Modify a user v1 UserModifyService
Delete a user v1 UserDeleteService
REST API Endpoint REST API Version SDK Service
Create a group v1 GroupCreateService
List all groups v1 GroupsListService
Retrieve group details v1 GroupDetailsService
Modify a group v1 GroupModifyService
List all connectors within a group v1 GroupListConnectorsService
List all users within a group v1 GroupListUsersService
Add a user to a group v1 GroupAddUserService
Remove a user from a group v1 GroupRemoveUserService
Delete a group v1 GroupDeleteService
REST API Endpoint REST API Version SDK Service/Config
Create a destination v1 DestinationCreateService
Retrieve destination details v1 DestinationDetailsService
Modify a destination v1 DestinationModifyService
Run destination setup tests v1 DestinationSetupTestsService
Delete a destination v1 DestinationDeleteService
Destination Config v1 DestinationConfig
REST API Endpoint REST API Version SDK Service/Config/Auth
Retrieve source metadata v1 ConnectorsSourceMetadataService
Create a connector v2 ConnectorCreateService
Retrieve connector details v2 ConnectorDetailsService
Modify a connector v2 ConnectorModifyService
Sync connector data v1 ConnectorSyncService
Re-sync connector table data v1 ConnectorReSyncTableService
Run connector setup tests v2 ConnectorSetupTestsService
Delete a connector v1 ConnectorDeleteService
Retrieve a connector schema config not implemented
Retrieve source table columns config not implemented
Reload a connector schema config not implemented
Modify a connector schema config not implemented
Modify a connector database schema config not implemented
Modify a connector table config not implemented
Modify a connector column config not implemented
Connector Config v1 ConnectorConfig
ConnectorConfigReports
ConnectorConfigProjectCredentials
ConnectorConfigCustomTables
Connector Auth v1 ConnectorAuth
ConnectorAuthClientAccess
Connect Card not implemented
REST API Endpoint REST API Version SDK Service
Approve a connector certificate v1 CertificateConnectorCertificateApproveService
Approve a connector fingerprint v1 CertificateConnectorFingerprintApproveService
Approve a destination certificate v1 CertificateDestinationCertificateApproveService
Approve a destination fingerprint v1 CertificateDestinationFingerprintApproveService

Support

Please get in touch with us through our Support Portal if you have any comments, suggestions, support requests, or bug reports.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.