Drive SDK

  go get github.com/deta/deta-go

  pip install deta

Using NPM:

npm install deta

Using Yarn:

yarn add deta

import (
	"fmt"

	"github.com/deta/deta-go/deta"
	"github.com/deta/deta-go/service/drive"
)

func main() {

	// initialize with project key
	// returns ErrBadProjectKey if project key is invalid
	d, err := deta.New(deta.WithProjectKey("project_key"))
	if err != nil {
		fmt.Println("failed to init new Deta instance:", err)
		return
	}

	// initialize with drive name
	// returns ErrBadDriveName if base name is invalid
	drive, err := drive.New(d, "drive_name")
	if err != nil {
		fmt.Println("failed to init new Drive instance:", err)
		return
	}
}

const { Deta } = require('deta'); // import Deta

// this also works
import { Deta } from 'deta';

// Initialize with a Project Key
const deta = Deta('project key');

// You can create as many as you want
const photos = deta.Drive('photos');
const docs = deta.Drive('docs');

If you are using Deta Drive within a Deta Micro, you must include deta in your package.json file to install the latest sdk version.

A valid project key is pre-set in the Micro’s environment. There is no need to pass a key in the initialization step.

const { Drive } = require('deta');
const drive = Drive('simple_drive');

If you are using the deta npm package of 0.0.6 or below, Deta is the single default export and should be imported as such.

const Deta = require('deta');

from deta import Deta  # Import Deta

# Initialize with a Project Key
deta = Deta("project key")

# This how to connect to or create a database.
drive = deta.Drive("simple_drive")

# You can create as many as you want
photos = deta.Drive("photos")
docs = deta.Drive("docs")

If you are using Deta Drive within a Deta Micro, you must include deta in your requirements.txt file to install the latest sdk version.

A valid project key is pre-set in the Micro’s environment. There is no need to pass a key in the the initialization step.

from deta import Drive

drive = Drive("simple_drive")

put(name, data, *, path, content_type)

Parameters

• name (required) - string

  • Description: The name of the file.

• data - string | bytes | io.TextIOBase | io.BufferedIOBase | io.RawIOBase

  • Description: The data content of the file.

• path - string

  • Description: The local path of the file to be uploaded to drive.

• content_type - string

  • Description: The content type of the file to be uploaded to drive. If the content type is not provided, drive tries to figure out the content type from the name provided. It defaults to application/octet-stream if the content type can not be figured out from the file name.

  At least and at most one of two args data or path must be provided. path and content_type must be provided with the key words.

Returns

Returns the name of the file on a successful put, otherwise, raises an Exception on error.

Example

drive.put('hello.txt', 'Hello world')
drive.put(b'hello.txt', 'Hello world')
drive.put('hello.txt', content_type='text/plain')

import io
drive.put('hello.txt', io.StringIO('hello world'))
drive.put('hello.txt', io.BytesIO(b'hello world'))

f = open('./hello.txt', 'r')
drive.put('hello.txt', f)
f.close()

drive.put('hello.txt', path='./hello.txt')

Put(i *PutInput) (string, error)

Parameters

• i (required) - pointer to a PutInput

  • // PutInput input to Put operation
    type PutInput struct {
      // Name of the file
      Name string
      // io.Reader with contents of the file
      Body io.Reader
      // ContentType of the file to be uploaded to drive.
      ContentType string
    }

  • Name (required) - string
    • Description: Name of the file to be uploaded.
  • Body (required) - io.Reader
    • Description: File content to be uploaded.
  • ContentType - string
    • Description: If the content type is not provided, drive tries to figure out the content type from Name provided. It defaults to application/octet-stream if the content type can not be figured out from the file name.

Returns

Returns the name of the file on a successful put (otherwise empty name), and an error.

Example

import (
	"bufio"
	"fmt"
	"os"

	"github.com/deta/deta-go/deta"
	"github.com/deta/deta-go/service/drive"
)

func main() {

	// initialize with project key
	// returns ErrBadProjectKey if project key is invalid
	d, err := deta.New(deta.WithProjectKey("project_key"))
	if err != nil {
		fmt.Println("failed to init new Deta instance:", err)
		return
	}

	// initialize with drive name
	// returns ErrBadDriveName if drive name is invalid
	drawings, err := drive.New(d, "drawings")
	if err != nil {
		fmt.Println("failed to init new Drive instance:", err)
		return
	}
	// PUT
	// reading from a local file
	file, err := os.Open("./art.svg")
	defer file.Close()

	name, err := drawings.Put(&drive.PutInput{
		Name:        "art.svg",
		Body:        bufio.NewReader(file),
		ContentType: "image/svg+xml",
	})
	if err != nil {
		fmt.Println("failed to put file:", err)
		return
	}
	fmt.Println("Successfully put file with name:", name)
}

async put(name, options)

Parameters

• name (required) - string

  • Description: The name of the file.

• options (required) - {data : string | Uint8Array | Buffer, path: string, contentType: string}

  • Description: An object with three optional parameters.
    • data - string or Buffer
      • Description: Either the data string or a buffer.
    • path - string
      • Description: The path of the file to be uploaded to drive.
    • contentType - string
      • Description: The content type of the file to be uploaded to drive. If the content type is not provided, drive tries to figure out the content type from the name provided. It defaults to application/octet-stream if the content type can not be figured out from the file name.

  options must have at least and at most one of two properties data or path defined.

Returns

Returns a promise which resolves to the name of the item on a successful put, otherwise, it throws an Error on error.

Example

drive.put('hello.txt', {data: "Hello world"});
drive.put('hello.txt', {data: "Hello world", contentType: 'text/plain'});

drive.put('hello.txt', {data: Buffer.from('Hello World'), contentType: 'text/plain'});
drive.put('hello.txt', {path: './my/file/path/file.txt'});
drive.put('hello.txt', {path: './my/file/path/file.txt', contentType: 'text/plain'}});

Get(name string) (io.ReadCloser, error)

Parameters

• name (required) - string
  • Description: The name of the file to get.

Returns

Returns a io.ReadCloser for the file.

Example

import (
	"fmt"
	"io/ioutil"

	"github.com/deta/deta-go/deta"
	"github.com/deta/deta-go/service/drive"
)

func main() {

	// initialize with project key
	// returns ErrBadProjectKey if project key is invalid
	d, err := deta.New(deta.WithProjectKey("project_key"))
	if err != nil {
		fmt.Println("failed to init new Deta instance:", err)
		return
	}

	// initialize with drive name
	// returns ErrBadDriveName if drive name is invalid
	drawings, err := drive.New(d, "drawings")
	if err != nil {
		fmt.Println("failed to init new Drive instance:", err)
		return
	}

	// GET
	name := "art.svg"
	f, err := drawings.Get(name)
	if err != nil {
		fmt.Println("failed to get file with name:", name)
		return
	}
	defer f.Close()

	c, err := ioutil.ReadAll(f)
	if err != nil {
		fmt.Println("failed read file content with err:", err)
		return
	}
	fmt.Println("file content:", string(c))
}

async get(name)

Parameters

• name (required) - string
  • Description: The name of the file to get.

Returns

Returns a promise that resolves to a blob of data if found, else null. Throws an Error on errors.

Example

const buf = await drive.get("hello.txt");

get(name)

Parameters

• name (required) - string
  • Description: The name of the file to get.

Returns

Returns a instance of a DriveStreamingBody class which has the following methods/properties.

• read(size=None) : Reads all or up to the next size bytes. Calling read after all the content has been read will return empty bytes.

• iter_chunks(chunk_size:int=1024) : Returns an iterator that yields chunks of bytes of chunk_size at a time.

• iter_lines(chunk_size:int=1024) : Returns an iterator that yields lines from the stream. Bytes of chunk_size at a time is read from the raw stream and lines are yielded from there. The line delimiter is always b'\n'.

• close() : Closes the stream.

• closed : Returns True if the stream has been closed.

Example

hello = drive.get('hello.txt')
content = hello.read()
hello.close()

# larger files
# iterate chunks of size 4096 and save to disk
large_file = drive.get('large_file.txt')
with open("large_file.txt", "wb+") as f:
  for chunk in large_file.iter_chunks(4096):
      f.write(chunk)
  large_file.close()

Delete(name string) (string, error)

Parameters

• name (required) - string
  • Description: The name of the file to delete

Returns

Returns the name of the deleted file on successful deletions, and an error.

If the file did not exist, the name is still returned.

Example

import (
	"fmt"

	"github.com/deta/deta-go/deta"
	"github.com/deta/deta-go/service/drive"
)

func main() {

	// initialize with project key
	// returns ErrBadProjectKey if project key is invalid
	d, err := deta.New(deta.WithProjectKey("project_key"))
	if err != nil {
		fmt.Println("failed to init new Deta instance:", err)
		return
	}

	// initialize with drive name
	// returns ErrBadDriveName if drive name is invalid
	drawings, err := drive.New(d, "drawings")
	if err != nil {
		fmt.Println("failed to init new Drive instance:", err)
		return
	}

	// DELETE
	name, err := drawings.Delete("art.svg")
	if err != nil {
		fmt.Println("failed to delete file with name:", name)
		return
	}
	fmt.Println("Successfully deleted file with name:", name)
}

async delete(name)

Parameters

• name (required) - string
  • Description: The name of the file to delete

Returns

Returns a promise that resolves to the name of the deleted file on successful deletions, otherwise raises an Error

If the file did not exist, the file is still returned as deleted.

Example

const deletedFile = await drive.delete("hello.txt");

delete(name)

Parameters

• name (required) - string
  • Description: The name of the file to delete

Returns

Returns the name of the deleted file on successful deletions, otherwise raises an Exception

If the file did not exist, the file is still returned as deleted.

Example

deleted_file = drive.delete("hello.txt")

DeleteMany(names []string) (*DeleteManyOutput, error)

Parameters

• names (required): []string
• Description: The names of the files to be deleted.

Returns

Returns a pointer to a DeleteManyOutput and an error.

// DeleteManyOutput output to DeleteMany operation
type DeleteManyOutput struct {
	Deleted []string          `json:"deleted"`
	Failed  map[string]string `json:"failed"`
}

• Deleted - string slice indicating deleted file names.
• Failled - map indicating the names of failed file names along with an error message.

Example

import (
	"fmt"

	"github.com/deta/deta-go/deta"
	"github.com/deta/deta-go/service/drive"
)

func main() {
	// initialize with project key
	// returns ErrBadProjectKey if project key is invalid
	d, err := deta.New(deta.WithProjectKey("project_key"))
	if err != nil {
		fmt.Println("failed to init new Deta instance:", err)
		return
	}

	// initialize with drive name
	// returns ErrBadDriveName if drive name is invalid
	drawings, err := drive.New(d, "drawings")
	if err != nil {
		fmt.Println("failed to init new Drive instance:", err)
		return
	}

	names := []string{"a", "b", "c"}
	dr, err := drawings.DeleteMany(names)

	if err != nil {
		fmt.Println("failed to delete files")
		return
	}
	fmt.Println("deleted:", dr.Deleted)
	fmt.Println("failed:", dr.Failed)
}

async deleteMany(names)

Parameters

• names (required) - Array of string
  • description: The names of the files to be deleted.

Returns

Returns a promise which resolves to an object with deleted and failed keys indicating deleted and failed file names.

{
  deleted : ["file1.txt", "file2.txt", ...],
  failed: {
    "file_3.txt": "reason for failure",
  }
}

If a file did not exist, the file is still returned as deleted.

Example

const result = await drive.DeleteMany(["file1.txt", "file2.txt"]);
console.log("deleted:", result.deleted);
console.log("failed:", result.failed);

delete_many(names)

Parameters

• names (required): string
  • Description: The names of the files to be deleted.

Returns

Returns a dict with deleted and failed keys indicating deleted and failed file names.

{
  "deleted" : ["file1.txt", "file2.txt", ...],
  "failed": {
    "file_3.txt": "reason for failure"
  }
}

If a file did not exist, the file is still returned as deleted.

Example

result = drive.delete_many(["file1.txt", "file2.txt"]);
print("deleted:", result.get("deleted"))
print("failed:", result.get("failed"))

List(limit int, prefix, last string) (*ListOutput, error)

Parameters

• limit (required) - int
  • Description: Maximum number of file names to be returned.
• prefix (required) - string
  • Description: The prefix that file names must have.
• last (required) - string
  • Description: The last name seen in a previous paginated result. Provide last from previous response to fetch further pages.

Returns

Returns a pointer to a ListOutput

type ListOutput struct {
	Paging *paging  `json:"paging"`
	Names  []string `json:"names"`
}

type paging struct {
	Size int     `json:"size"`
	Last *string `json:"last"`
}

• Paging - indicates the size and last name of the current page. nil if there are no further pages.
• Names - names of the files.

Example

import (
	"fmt"

	"github.com/deta/deta-go/deta"
	"github.com/deta/deta-go/service/drive"
)

func main() {

	// initialize with project key
	// returns ErrBadProjectKey if project key is invalid
	d, err := deta.New(deta.WithProjectKey("project_key"))
	if err != nil {
		fmt.Println("failed to init new Deta instance:", err)
		return
	}

	// initialize with drive name
	// returns ErrBadDriveName if drive name is invalid
	drawings, err := drive.New(d, "drawings")
	if err != nil {
		fmt.Println("failed to init new Drive instance:", err)
		return
	}

	lr, err := drawings.List(1000, "", "")
	if err != nil {
		fmt.Println("failed to list names from drive with err:", err)
	}
	// ["a", "b", "c/d"]
	fmt.Println("names:", lr.Names)

	lr, err = drawings.List(1, "", "")
	if err != nil {
		fmt.Println("failed to list names from drive with err:", err)
	}
	// ["a"]
	fmt.Println("names:", lr.Names)


	lr, err = drawings.List(2, "", "")
	if err != nil {
		fmt.Println("failed to list names from drive with err:", err)
	}
	// "b"
	fmt.Println("last:", *lr.Paging.Last)
}

list(limit, prefix, last)

Parameters

• limit: int
  • Description: The maximum number of files names to be returned, defaults to 1000
• prefix: string
  • Description: The prefix that file names must have.
• last: string
  • Description: The last name seen in a previous paginated result. Provide last from previous response to fetch further pages.

Returns

Returns a dict with paging and names keys.

{
  "names": ["file1.txt", "file2.txt", ...],
  "paging": {
    "size": 2,
    "last": "file_2.txt"
  }
}

• names: The names of the files
• paging: Contains paging information.
  • size : The number of files returned.
  • last : The last name seen in the paginated response. Provide this value in subsequent api calls to fetch further pages. For the last page, last is not present in the response.

Example

# get all files
result = drive.list()

all_files = result.get("names")
paging = result.get("paging")
last = paging.get("last") if paging else None

while (last):
  # provide last from previous call
  result = drive.list(last=last)

  all_files += result.get("names")
  # update last
  paging = result.get("paging")
  last = paging.get("last") if paging else None

print("all files:", all_files)

res_with_prefix = drive.list(prefix="/blog")
res_with_limit = drive.list(limit=100)
res_with_prefix_limit = drive.list(prefix="/blog", limit=100)

async list(options)

Parameters

• options (required) : {prefix: string, limit: number, last: string}
  • Description: An object with three optional parameters.
    • prefix: string
      • Description: The prefix that file names must have.
    • limit: number
      • Description: The maximum number of files names to be returned, defaults to 1000
    • last: string
      • Description: The last name seen in a previous paginated result. Provide last to fetch further pages.

Returns

Returns a promise which resolves to an object with paging and names keys.

{
  names: ["file1.txt", "file2.txt", ...],
  paging: {
    size: 2,
    last: "file_2.txt"
  }
}

• names: The names of the files
• paging: Contains paging information.
  • size : The number of files returned.
  • last : The last name seen in the paginated response. Provide this value in subsequent api calls to fetch further pages. For the last page, last is not present in the response.

Example

// get all files
let result = await drive.list();
let allFiles = result.names;
let last = result.paging.last;

while (last) {
  // provide last from previous call
  result = await drive.list({ last: result.paging.last });

  allFiles = allFiles.concat(result.names);

  // update last
  last = result.paging.last;
}
console.log("all files:", allFiles);

const resultWithPrefix = await drive.list({ prefix: "blog/" });
const resultWithLimit = await drive.list({ limit: 100 });
const resultWIthLimitAndPrefix = await drive.list({
  limit: 100,
  prefix: "blog/",
});