Drive

No async implementation yet.

function Drive(driveName: string, host?: string);

The Drive class provides methods to interact with a Deta Drive.

func New(d *Deta, driveName string) (*Drive, error)

The Drive class provides methods to interact with a Deta Drive.

Returns a pointer to a Drive instance.

def Drive(name: str, host: str | None = None):

The Drive class provides methods to interact with a Deta Drive.

No async implementation yet.

func (d *Drive) Put(i *PutInput) (string, error)

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

Example:

name, err := drv.Put(&drive.PutInput{
    Name: "hello.txt",
    Body: bufio.NewReader(file),
    ContentType: "text/plain",
})

async function put(
    name: string,
    options: PutOptions,
): Promise<PutResponse>;

options must have exactly one of two properties data or path defined.

data is a Blob or ArrayBuffer of the file data.

path is a string of the path to the file on the local filesystem.

Returns a promise which resolves to a PutResponse containing the name of the item. If the operation did not complete successfully, throws an Error.

Example:

await drive.put("hello.txt", { data: "Hello world!" });
await drive.put("example.txt", { path: "path/to/example.txt" });

def put(
    name: str,
    data: str | bytes | io.TextIOBase | io.BufferedIOBase | io.RawIOBase,
    path: str,
    content_type: str | None = None,
) -> str:

You must pass either data or path, but not both.

If name is not a non-empty string, raises a ValueError. If neither or both data and path are passed, raises a ValueError. Returns an str containing the name of the file. If the operation did not complete successfully, raises an Exception.

Example:

drive.put("hello.txt", data="Hello world!")
drive.put("example.txt", path="path/to/example.txt")

No async implementation yet.

func (d *Drive) Get(name string) (io.ReadCloser, error)

Returns an io.ReadCloser for the file, and an error.

Example:

file, err := drv.Get("hello.txt")

async function get(name: string): Promise<GetResponse>;

Returns a promise that resolves to a GetResponse containing a Blob of the data if found, otherwise null. If the operation did not complete successfully, throws an Error.

Example:

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

def get(name: str) -> DriveStreamingBody | None:

Returns an instance of DriveStreamingBody. If name is not a non-empty string, raises a ValueError.

Example:

response = drive.get("hello.txt")
content = response.read()

No async implementation yet.

func (d *Drive) Delete(name string) (string, error)

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

ℹ️ If the file did not exist, the name is still returned as if it were deleted.

Example:

name, err := drv.Delete("hello.txt")

async function delete(name: string): Promise<DeleteResponse>;

Returns a promise that resolves to a DeleteResponse containing the name of the deleted file. If the operation did not complete successfully, throws an Error.

ℹ️ If the file did not exist, the name is still returned as if it were deleted.

Example:

await drive.delete("hello.txt");

def delete(name: str) -> str:

Returns an str containing the name of the deleted file. If name is not a non-empty string, raises a ValueError. If the operation did not complete successfully, raises an Exception.

ℹ️ If the file did not exist, the name is still returned as if it were deleted.

Example:

drive.delete("hello.txt")

No async implementation yet.

async function deleteMany(names: string[]): Promise<DeleteManyResponse>;

Returns a promise which resolves to a DeleteManyResponse.

ℹ️ If the file did not exist, the name is still returned as if it were deleted.

Example:

await drive.deleteMany(["hello.txt", "example.txt"]);

def delete_many(names: Sequence[str]) -> dict:

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

ℹ️ If the file did not exist, the name is still returned as if it were deleted.

Example:

drive.delete_many(["hello.txt", "example.txt"])

func (d *Drive) DeleteMany(names []string) (*DeleteManyOutput, error)

Returns a pointer to a DeleteManyOutput, and an error.

ℹ️ If the file did not exist, the name is still returned as if it were deleted.

Example:

names := []string{"hello.txt", "example.txt"}
response, err := drv.DeleteMany(names)

No async implementation yet.

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

Returns a pointer to a ListOutput, and an error.

Example:

response, err := drv.List(1000, "", "")

async function list(options?: ListOptions): Promise<ListResponse>;

Returns a promise which resolves to a ListRepsonse.

Example:

const names = await drive.list().names;

def list(
    limit: int = 1000,
    prefix: str | None = None,
    last: str | None = None,
) -> dict[str, Any]:

Returns a dict with "paging" and "names" keys.

• "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:

response = drive.list()["names"]