ObjectDB S3 SDK examples.

from __future__ import annotations

import boto3
from botocore import UNSIGNED
from botocore.config import Config
from botocore.exceptions import ClientError


endpoint = "http://127.0.0.1:18080"
bucket = "docs-058-sdk"
key = "raw/photo.txt"
body = b"objectdb-sdk-body"

s3 = boto3.client(
    "s3",
    endpoint_url=endpoint,
    region_name="us-east-1",
    config=Config(signature_version=UNSIGNED, s3={"addressing_style": "path"}),
)


def main() -> None:
    s3.create_bucket(Bucket=bucket)

    s3.put_object(
        Bucket=bucket,
        Key=key,
        Body=body,
        ContentType="text/plain",
        Metadata={"source": "docs-058", "workflow": "sdk-example"},
        Tagging="kind=raw&stage=example",
    )

    get_result = s3.get_object(Bucket=bucket, Key=key)
    payload = get_result["Body"].read()
    assert payload == body

    listed = s3.list_objects_v2(Bucket=bucket, Prefix="raw/")
    keys = [entry["Key"] for entry in listed.get("Contents", [])]
    assert key in keys

    tags = s3.get_object_tagging(Bucket=bucket, Key=key)["TagSet"]
    assert {"Key": "stage", "Value": "example"} in tags

    try:
        s3.get_bucket_versioning(Bucket=bucket)
    except ClientError as error:
        assert error.response["Error"]["Code"] == "NotImplemented"
    else:
        raise AssertionError("ObjectDB s3-core-v1 should not report versioning support")

    s3.delete_object(Bucket=bucket, Key=key)
    s3.delete_bucket(Bucket=bucket)


if __name__ == "__main__":
    main()

import {
  CreateBucketCommand,
  DeleteBucketCommand,
  DeleteObjectCommand,
  GetBucketVersioningCommand,
  GetObjectCommand,
  GetObjectTaggingCommand,
  ListObjectsV2Command,
  PutObjectCommand,
  S3Client,
  S3ServiceException,
} from "@aws-sdk/client-s3";

const endpoint = "http://127.0.0.1:18080";
const bucket = "docs-058-sdk";
const key = "raw/photo.txt";
const body = "objectdb-sdk-body";

const s3 = new S3Client({
  endpoint,
  region: "us-east-1",
  forcePathStyle: true,
  credentials: {
    accessKeyId: "OBJECTDB_LOCAL_ACCESS_KEY",
    secretAccessKey: "OBJECTDB_LOCAL_SECRET_KEY",
  },
});

async function main(): Promise<void> {
  await s3.send(new CreateBucketCommand({ Bucket: bucket }));

  await s3.send(
    new PutObjectCommand({
      Bucket: bucket,
      Key: key,
      Body: body,
      ContentType: "text/plain",
      Metadata: {
        source: "docs-058",
        workflow: "sdk-example",
      },
      Tagging: "kind=raw&stage=example",
    })
  );

  const getResult = await s3.send(
    new GetObjectCommand({ Bucket: bucket, Key: key })
  );
  const payload = await getResult.Body?.transformToString();

  if (payload !== body) {
    throw new Error("ObjectDB returned an unexpected object body");
  }

  const listed = await s3.send(
    new ListObjectsV2Command({ Bucket: bucket, Prefix: "raw/" })
  );
  const keys = (listed.Contents ?? []).map((object) => object.Key);

  if (!keys.includes(key)) {
    throw new Error("ObjectDB did not list the uploaded object");
  }

  const tagResult = await s3.send(
    new GetObjectTaggingCommand({ Bucket: bucket, Key: key })
  );
  const hasExampleTag = (tagResult.TagSet ?? []).some(
    (tag) => tag.Key === "stage" && tag.Value === "example"
  );

  if (!hasExampleTag) {
    throw new Error("ObjectDB did not return the expected object tag");
  }

  try {
    await s3.send(new GetBucketVersioningCommand({ Bucket: bucket }));
    throw new Error("ObjectDB s3-core-v1 should not report versioning support");
  } catch (error) {
    if (
      !(error instanceof S3ServiceException) ||
      error.name !== "NotImplemented"
    ) {
      throw error;
    }
  }

  await s3.send(new DeleteObjectCommand({ Bucket: bucket, Key: key }));
  await s3.send(new DeleteBucketCommand({ Bucket: bucket }));
}

void main();