Guide

Verification Required

ObjectDB S3 SDK examples.

Illustrative Python boto3 and AWS SDK for JavaScript v3 workflows for common ObjectDB S3 Core operations, with explicit route evidence and unsupported behavior boundaries.

Current availability

Private Beta. Public beta is scheduled for .

Example Status

SDK Snippets

Verification Required

These examples are illustrative. They demonstrate client-call shape, not validated SDK package coverage.

S3 Core Routes

Live

The bucket, object, listing, tags, metadata, and unsupported behavior references map back to ObjectDB route docs and product tests.

Example Snapshot

Example status
Illustrative
Clients
2
Profile
s3-core-v1
Evidence
ODB-EVID-012

Source Files

Example source bundle
LanguageClientStatusAuth noteSource
Pythonboto3illustrativeUses unsigned path-style local requests to mirror the local quickstart surface.docs/examples/objectdb/s3-sdk-examples/snippets/python-boto3-s3-core.py
TypeScriptAWS SDK for JavaScript v3illustrativeUses placeholder SigV4 credentials that must map to accepted local ObjectDB credential configuration before execution.docs/examples/objectdb/s3-sdk-examples/snippets/typescript-aws-sdk-v3-s3-core.ts

Example Guardrails

Illustrative Status

The snippets show client-call shape. They are not the first-success path and should not be treated as tested SDK compatibility until reviewer-run evidence exists.

Route Evidence

Bucket lifecycle, object CRUD, list, tags, metadata, and unsupported behavior stay tied to the ObjectDB S3 Core route tests and references.

Auth Boundary

Credential setup remains environment-specific. Keep real access keys out of docs source, examples, output, screenshots, and support evidence.

SDK Snippets

ObjectDB S3 Core SDK snippets

Switch between illustrative Python and TypeScript client-call shapes. Copy only local placeholder snippets into a reviewed environment.

Python

docs/examples/objectdb/s3-sdk-examples/snippets/python-boto3-s3-core.py

Path-style unsigned local requests mirroring the ObjectDB quickstart surface.

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"}),
)

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",
)

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

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

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)

Text

Expected Output

Safe reviewer-visible outcomes from the source example bundle.

ObjectDB S3 Core SDK example summary

Expected reviewer-visible outcomes:

- CreateBucket accepts bucket docs-058-sdk.
- PutObject stores raw/photo.txt with Content-Type text/plain.
- GetObject returns objectdb-sdk-body.
- ListObjectsV2 with Prefix raw/ includes raw/photo.txt.
- GetObjectTagging returns stage=example.
- GetBucketVersioning returns an S3-shaped NotImplemented error.
- DeleteObject and DeleteBucket clean up the example resources.

Status:

- Snippets are illustrative until product SME and docs QA accept exact SDK package versions, auth setup, command transcript, and output.
- Equivalent route behavior is covered by ObjectDB S3 Core route docs and product tests.

Coverage Map

Behavior, SDK call, and evidence mapping
BehaviorSDK callEvidenceStatus
Create a bucketCreateBucketODB-EVID-006, ODB-EVID-007, S3CoreApiTestsRoute behavior source-backed
Put an objectPutObjectODB-EVID-006, ODB-EVID-007, S3CoreApiTestsRoute behavior source-backed
Get an objectGetObjectODB-EVID-006, ODB-EVID-007, S3CoreApiTestsRoute behavior source-backed
List by prefixListObjectsV2ODB-EVID-006, ODB-EVID-009, S3CoreApiTestsRoute behavior source-backed
Write metadata and tagsPutObject Metadata and TaggingODB-EVID-009, S3MetadataCopyWorkflowTestsRoute behavior source-backed
Read object tagsGetObjectTaggingODB-EVID-009, S3MetadataCopyWorkflowTestsRoute behavior source-backed
Handle unsupported versioningGetBucketVersioningODB-EVID-002, ODB-EVID-006, ODB-EVID-009, DOCS-042Unsupported behavior source-backed

Unsupported Behavior Notes

Versioning is included as the negative example because ObjectDB documents advanced S3 families as outside the active s3-core-v1 profile. SDK callers should treat NotImplemented as an explicit boundary and return to the compatibility matrix before adding more S3 operations.

Validation And Evidence

DOCS-058 review evidence
AreaEvidenceReviewer status
Example source layoutDOCS-057 and docs/examples/README.mdpending
Rendered guide routeDOCS-058 and /products/objectdb/guides/s3-sdk-examples/pending
Route-equivalent product behaviorS3CoreApiTests.cs, S3MetadataCopyWorkflowTests.cs, and ObjectDB S3 Core docspending
SDK package and auth setupReviewer-run transcript; DOCS-063 covers manifest validationneeded before status promotion

Safe Next Steps

  • Available: DOCS-022

    Run the local quickstart

    Use the curl workflow for a copy/paste local first success before adapting SDK calls.

  • Available: DOCS-038

    Check S3 Core compatibility

    Confirm every SDK call maps to a supported, partial, unsupported, preview, future, or verification-required row.

  • Available: DOCS-029

    Read S3 and HTTP reference

    Use route shapes, error behavior, and local adapter constraints when converting examples into runnable code.

  • Available: DOCS-063

    Add example validation

    Use the manifest gate before changing these examples or promoting them beyond illustrative status.