Skip to content

Start with Go

Learn how to set up your first Go project powered by Appwrite.

1

Head to the Appwrite Console.

If this is your first time using Appwrite, create an account and create your first project.

Create project screen

Create project screen

Then, under Integrate with your server, add an API Key with the following scopes.

Create project screen

Create project screen

CategoryRequired scopesPurpose
Database
databases.write
Allows API key to create, update, and delete databases.
tables.write
Allows API key to create, update, and delete tables.
columns.write
Allows API key to create, update, and delete columns.
rows.read
Allows API key to read rows.
rows.write
Allows API key to create, update, and delete rows.

Other scopes are optional.

2

Create a go application.

Shell
mkdir my-app
cd my-app
go mod init go-appwrite/main
3

Install the Go Appwrite SDK.

Shell
go get github.com/appwrite/sdk-for-go
4

Find your project ID in the Settings page. Also, click on the View API Keys button to find the API key that was created earlier.

Project settings screen

Project settings screen

Create a new file called app.go, initialize a function, and initialize the Appwrite Client. Replace <PROJECT_ID> with your project ID and <YOUR_API_KEY> with your API key. Import the Appwrite dependencies for appwrite, client, databases, and models.

Go
package main

import (
	"github.com/appwrite/sdk-for-go/appwrite"
	"github.com/appwrite/sdk-for-go/client"
	"github.com/appwrite/sdk-for-go/tablesDB"
	"github.com/appwrite/sdk-for-go/models"
)

var (
	appwriteClient    client.Client
	todoDatabase      *models.Database
	todoTable    *models.Table
	appwriteDatabases *tablesDB.TablesDB
)

func main() {
	appwriteClient = appwrite.NewClient(
		appwrite.WithProject("<PROJECT_KEY>"),
		appwrite.WithKey("<API_KEY>"),
	)
}
5

Once the Appwrite Client is initialized, create a function to configure a todo table. Import the id Appwrite dependency by adding "github.com/appwrite/sdk-for-go/id" to the imported dependencies list.

Go
func prepareDatabase() {
	tablesDB = appwrite.NewTablesDB(appwriteClient)

	todoDatabase, _ = tablesDB.Create(
		id.Unique(),
		"TodosDB",
	)

	todoTable, _ = tablesDB.CreateTable(
		todoDatabase.Id,
		id.Unique(),
		"Todos",
	)

	tablesDB.CreateStringColumn(
		todoDatabase.Id,
		todoTable.Id,
		"title",
		255,
		true,
	)

	tablesDB.CreateStringColumn(
		todoDatabase.Id,
		todoTable.Id,
		"description",
		255,
		false,
	)

	tablesDB.CreateBooleanColumn(
		todoDatabase.Id,
		todoTable.Id,
		"isComplete",
		true,
	)
}
6

Create a function to add some mock data to your new table.

Go
func seedDatabase() {
	testTodo1 := map[string]interface{}{
		"title":       "Buy apples",
		"description": "At least 2KGs",
		"isComplete":  true,
	}

	testTodo2 := map[string]interface{}{
		"title":      "Wash the apples",
		"isComplete": true,
	}

	testTodo3 := map[string]interface{}{
		"title":       "Cut the apples",
		"description": "Don't forget to pack them in a box",
		"isComplete":  false,
	}

	tablesDB.createRow(
		todoDatabase.Id,
		todoTable.Id,
		id.Unique(),
		testTodo1,
	)

	tablesDB.createRow(
		todoDatabase.Id,
		todoTable.Id,
		id.Unique(),
		testTodo2,
	)

	tablesDB.createRow(
		todoDatabase.Id,
		todoTable.Id,
		id.Unique(),
		testTodo3,
	)
}
7

Create a function to retrieve the mock todo data.

Go
type Todo struct {
	Title       string `json:"title"`
	Description string `json:"description"`
	IsComplete  bool   `json:"isComplete"`
}

type TodoList struct {
	*models.DocumentList
	Documents []Todo `json:"rows"`
}

func getTodos() {
	todoResponse, _ := tablesDB.listRows(
		todoDatabase.Id,
		todoTable.Id,
	)

	var todos TodoList
	todoResponse.Decode(&todos)

	for _, todo := range todos.Documents {
		fmt.Printf("Title: %s\nDescription: %s\nIs Todo Complete: %t\n\n", todo.Title, todo.Description, todo.IsComplete)
	}
}

Make sure to update main() with the functions you created. Your main() function should look something like this:

Go
package main

import (
	"fmt"

	"github.com/appwrite/sdk-for-go/appwrite"
	"github.com/appwrite/sdk-for-go/client"
	"github.com/appwrite/sdk-for-go/tablesDB"
	"github.com/appwrite/sdk-for-go/id"
	"github.com/appwrite/sdk-for-go/models"
)

var (
	appwriteClient    client.Client
	todoDatabase      *models.Database
	todoTable    *models.Table
	tablesDB *tablesDB.TablesDB
)

func main() {
	appwriteClient = appwrite.NewClient(
		appwrite.WithProject("<PROJECT_KEY>"),
		appwrite.WithKey("<API_KEY>"),
	)

	prepareDatabase()
	seedDatabase()
	getTodos()
}
8

Run your project with go run . and view the response in your console.