Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/speakeasy-sdks/neon-go

A go SDK for accessing the neon-go API.
https://github.com/speakeasy-sdks/neon-go

Last synced: 2 days ago
JSON representation

A go SDK for accessing the neon-go API.

Host: GitHub
URL: https://github.com/speakeasy-sdks/neon-go
Owner: speakeasy-sdks
License: mit
Created: 2023-05-23T16:28:16.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-04-02T21:21:18.000Z (7 months ago)
Last Synced: 2024-04-28T05:14:47.110Z (6 months ago)
Size: 109 KB
Stars: 0
Watchers: 5
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

        


    

    Neon Go SDK

   Fully managed serverless PostgreSQL

   

   

  

  



## SDK Installation

```bash

go get github.com/speakeasy-sdks/neon-go

```

## SDK Example Usage

```go

package main

import(

	"context"

	"log"

	"neon"

	"neon/pkg/models/shared"

)

func main() {

    s := sdk.New(

        sdk.WithSecurity(shared.Security{

            BearerAuth: "YOUR_BEARER_TOKEN_HERE",

        }),

    )

    ctx := context.Background()

    res, err := s.APIKey.CreateAPIKey(ctx, shared.APIKeyCreateRequest{

        KeyName: "corrupti",

    })

    if err != nil {

        log.Fatal(err)

    }

    if res.APIKeyCreateResponse != nil {

        // handle response

    }

}

```

## Available Resources and Operations

### [APIKey](docs/apikey/README.md)

* [CreateAPIKey](docs/apikey/README.md#createapikey) - Create an API key

* [ListAPIKeys](docs/apikey/README.md#listapikeys) - Get a list of API keys

* [RevokeAPIKey](docs/apikey/README.md#revokeapikey) - Revoke an API key

### [Branch](docs/branch/README.md)

* [CreateProjectBranch](docs/branch/README.md#createprojectbranch) - Create a branch

* [CreateProjectBranchDatabase](docs/branch/README.md#createprojectbranchdatabase) - Create a database

* [CreateProjectBranchRole](docs/branch/README.md#createprojectbranchrole) - Create a role

* [DeleteProjectBranch](docs/branch/README.md#deleteprojectbranch) - Delete a branch

* [DeleteProjectBranchDatabase](docs/branch/README.md#deleteprojectbranchdatabase) - Delete a database

* [DeleteProjectBranchRole](docs/branch/README.md#deleteprojectbranchrole) - Delete a role

* [GetProjectBranch](docs/branch/README.md#getprojectbranch) - Get branch details

* [GetProjectBranchDatabase](docs/branch/README.md#getprojectbranchdatabase) - Get database details

* [GetProjectBranchRole](docs/branch/README.md#getprojectbranchrole) - Get role details

* [GetProjectBranchRolePassword](docs/branch/README.md#getprojectbranchrolepassword) - Get role password

* [ListProjectBranchDatabases](docs/branch/README.md#listprojectbranchdatabases) - Get a list of databases

* [ListProjectBranchEndpoints](docs/branch/README.md#listprojectbranchendpoints) - Get a list of branch endpoints

* [ListProjectBranchRoles](docs/branch/README.md#listprojectbranchroles) - Get a list of roles

* [ListProjectBranches](docs/branch/README.md#listprojectbranches) - Get a list of branches

* [ResetProjectBranchRolePassword](docs/branch/README.md#resetprojectbranchrolepassword) - Reset the role password

* [SetPrimaryProjectBranch](docs/branch/README.md#setprimaryprojectbranch) - Set the branch as the primary branch of a project

* [UpdateProjectBranch](docs/branch/README.md#updateprojectbranch) - Update a branch

* [UpdateProjectBranchDatabase](docs/branch/README.md#updateprojectbranchdatabase) - Update a database

### [Endpoint](docs/endpoint/README.md)

* [CreateProjectEndpoint](docs/endpoint/README.md#createprojectendpoint) - Create an endpoint

* [DeleteProjectEndpoint](docs/endpoint/README.md#deleteprojectendpoint) - Delete an endpoint

* [GetProjectEndpoint](docs/endpoint/README.md#getprojectendpoint) - Get an endpoint

* [ListProjectEndpoints](docs/endpoint/README.md#listprojectendpoints) - Get a list of endpoints

* [StartProjectEndpoint](docs/endpoint/README.md#startprojectendpoint) - Start an endpoint

* [SuspendProjectEndpoint](docs/endpoint/README.md#suspendprojectendpoint) - Suspend an endpoint

* [UpdateProjectEndpoint](docs/endpoint/README.md#updateprojectendpoint) - Update an endpoint

### [Operation](docs/operation/README.md)

* [GetProjectOperation](docs/operation/README.md#getprojectoperation) - Get operation details

* [ListProjectOperations](docs/operation/README.md#listprojectoperations) - Get a list of operations

### [Preview](docs/preview/README.md)

* [ListProjectsConsumption](docs/preview/README.md#listprojectsconsumption) - Get a list of projects consumption

### [Project](docs/project/README.md)

* [CreateProject](docs/project/README.md#createproject) - Create a project

* [DeleteProject](docs/project/README.md#deleteproject) - Delete a project

* [GetProject](docs/project/README.md#getproject) - Get project details

* [ListProjects](docs/project/README.md#listprojects) - Get a list of projects

* [UpdateProject](docs/project/README.md#updateproject) - Update a project

### Maturity

This SDK is in beta and therefore, we recommend pinning usage to a specific package version.

This way, you can install the same version each time without breaking changes unless you are intentionally

looking for the latest version.

### Contributions

While we value open-source contributions to this SDK, this library is generated and maintained programmatically.

Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release !

### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)