SDK Go: gestire i file dell'app

Il file manager si trova su c.Apps.Files. Ogni metodo accetta prima ctx e l’id dell’app, poi un percorso all’interno dell’app. I percorsi sono lunghi al massimo 256 caratteri. Ogni snippet qui sotto funziona da solo all’interno di questo programma: incollane uno alla volta in main ed esegui goimports (vedi Eseguire gli esempi).

package main

import (
	"context"
	"os"

	"github.com/squarecloudofc/sdk-api-go/v3"
)

var (
	ctx   = context.Background()
	c     = squarecloud.New(os.Getenv("SQUARECLOUD_API_KEY"))
	appID = "abc123def456abc123def456"
)

func main() {
	// Paste one snippet here, then run goimports.
}

Elencare una directory

Files.List(ctx, appID, path) elenca una directory ("" per la radice dell’app).

entries, err := c.Apps.Files.List(ctx, appID, "/src")
if err != nil {
	log.Fatal(err)
}
for _, entry := range entries {
	fmt.Println(entry.Type, entry.Name, entry.Size)
	if entry.LastModified != nil {
		fmt.Println(time.UnixMilli(int64(*entry.LastModified)))
	}
}

Campo	Tipo	Descrizione
`Name` (`name`)	`string`	Nome della voce
`Type` (`type`)	`string`	`"file"` o `"directory"`
`Size` (`size`)	`int64`	Dimensione in byte. `0` sulle voci di directory che l’API invia senza di essa
`LastModified` (`lastModified`)	`*float64`	Ms Unix (possono avere una parte frazionaria); `nil` se non leggibile

Una directory che non esiste produce 404 FILE_NOT_FOUND. Un percorso che il file manager non espone produce 403 BLOCKED_PATH.

Leggere un file

Files.Read(ctx, appID, path) restituisce i byte del file come []byte. I file sono limitati a 10 MB: uno più grande produce 413 FILE_TOO_LARGE.

data, err := c.Apps.Files.Read(ctx, appID, "/config.json")
if err != nil {
	log.Fatal(err)
}

var config map[string]any
if err := json.Unmarshal(data, &config); err != nil {
	log.Fatal(err)
}
fmt.Println(config)

Scrivere un file

Files.Write(ctx, appID, path, content) crea o sovrascrive un file. content è un []byte:

Viene sempre inviato in base64, quindi il contenuto testuale e binario resta identico byte per byte. Per scrivere una stringa, passa []byte(s).
Un contenuto vuoto (nil o uno slice vuoto) crea un file vuoto.

// Text
config, err := json.Marshal(map[string]bool{"debug": false})
if err != nil {
	log.Fatal(err)
}
if err := c.Apps.Files.Write(ctx, appID, "/config.json", config); err != nil {
	log.Fatal(err)
}

// Binary
res, err := http.Get("https://example.com/logo.png")
if err != nil {
	log.Fatal(err)
}
defer res.Body.Close()
image, err := io.ReadAll(res.Body)
if err != nil {
	log.Fatal(err)
}
if err := c.Apps.Files.Write(ctx, appID, "/assets/logo.png", image); err != nil {
	log.Fatal(err)
}

Un contenuto oltre i 10 MB fallisce localmente con FILE_TOO_LARGE (status 0) prima che venga inviato qualsiasi cosa. Un contenuto oltre 1 MiB non ha una scadenza predefinita, come un upload: limitalo o annullalo con ctx. Per file più grandi, usa Apps.Commit.

La scrittura non riavvia l’app. Chiama Apps.Restart per applicare la modifica.

Spostare o rinominare un file

if err := c.Apps.Files.Move(ctx, appID, "/config.json", "/config.old.json"); err != nil {
	log.Fatal(err)
}

Eliminare un file

if err := c.Apps.Files.Delete(ctx, appID, "/config.old.json"); err != nil {
	log.Fatal(err)
}

Errori

Status	Codice	Quando
0	`FILE_TOO_LARGE`	Contenuto di `Write` oltre 10 MB (controllato localmente)
400	`INVALID_PATH`	Il percorso non supera la validazione (attraversamento, caratteri non validi, troppo lungo), oppure `Move` verso lo stesso percorso
400	`DELETE_FAILED`, `RENAME_FAILED`	Il cluster non è riuscito a eliminare o rinominare il file
403	`BLOCKED_PATH`	Il percorso non è esposto dal file manager
403	`PERMISSION_DENIED`	Il tuo ruolo nel workspace non può modificare un file riservato (come `.env`)
404	`FILE_NOT_FOUND`	Il file o la directory non esiste
413	`FILE_TOO_LARGE`	`Read` di un file oltre 10 MB
429	`KEEP_CALM`	Più di 10 scritture in 5 secondi

Vedi Errori per i codici che qualsiasi chiamata può restituire.

Prossimi passi

Variabili d'ambiente

Leggi e modifica le variabili di un’app.

Riferimento API del file manager

Gli endpoint REST dietro questi metodi.

Gestire i file dalla CLI

Le stesse azioni dal terminale.

CLI

VS Code

SDKs

SDK Go: gestire i file dell'app

Elencare una directory

Leggere un file

Scrivere un file

Spostare o rinominare un file

Eliminare un file

Errori

Prossimi passi

Variabili d'ambiente

Riferimento API del file manager

Gestire i file dalla CLI

​Elencare una directory

​Leggere un file

​Scrivere un file

​Spostare o rinominare un file

​Eliminare un file

​Errori

​Prossimi passi

Variabili d'ambiente

Riferimento API del file manager

Gestire i file dalla CLI

Elencare una directory

Leggere un file

Scrivere un file

Spostare o rinominare un file

Eliminare un file

Errori

Prossimi passi