https://github.com/ariga/atlas-go-sdk

An SDK for building atlasgo.io providers
https://github.com/ariga/atlas-go-sdk

Last synced: 2 months ago
JSON representation

An SDK for building atlasgo.io providers

• Host: GitHub
• URL: https://github.com/ariga/atlas-go-sdk
• Owner: ariga
• License: apache-2.0
• Created: 2023-07-09T06:25:22.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2025-04-08T10:45:51.000Z (2 months ago)
• Last Synced: 2025-04-11T23:15:25.814Z (2 months ago)
• Language: Go
• Homepage:
• Size: 201 KB
• Stars: 22
• Watchers: 8
• Forks: 11
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Atlas SDK for Go

[![Go Reference](https://pkg.go.dev/badge/ariga.io/atlas-go-sdk/atlasexec.svg)](https://pkg.go.dev/ariga.io/atlas-go-sdk/atlasexec)

An SDK for building ariga/atlas providers in Go.

## Installation

```bash

go get -u ariga.io/atlas-go-sdk

```

## How to use

To use the SDK, you need to create a new client with your `migrations` folder and the `atlas` binary path.

```go

package main

import (

    ...

    "ariga.io/atlas-go-sdk/atlasexec"

)

func main() {

    // Create a new client

    client, err := atlasexec.NewClient("my-migration-folder", "my-atlas-cli-path")

    if err != nil {

        log.Fatalf("failed to create client: %v", err)

    }

}

```

## APIs

For more information, refer to the documentation available at [GoDoc](https://pkg.go.dev/ariga.io/atlas-go-sdk/atlasexec#Client)