Class OINONoSqlAwsDynamo

AWS DynamoDB implementation of OINONoSql.

Authenticates using static IAM credentials supplied as a JSON-encoded connection string. Connection parameters map as:

• params.url → optional custom endpoint URL (e.g. for DynamoDB Local: http://localhost:8000)
• params.table → DynamoDB table name
• params.connectionStr → JSON string: {"region":"…","accessKeyId":"…","secretAccessKey":"…"}
• params.staticPartitionKey → scope all operations to a fixed partition key

Register and use via the factory:

import { OINONoSqlFactory } from "@oino-ts/nosql"
import { OINONoSqlAwsDynamoDB } from "@oino-ts/nosql-aws"

OINONoSqlFactory.registerNoSql("OINONoSqlAwsDynamoDB", OINONoSqlAwsDynamoDB)

const nosql = await OINONoSqlFactory.createNoSql({
    type:          "OINONoSqlAwsDynamoDB",
    url:           "",
    table:         "myTable",
    connectionStr: JSON.stringify({
        region:          "us-east-1",
        accessKeyId:     process.env.AWS_ACCESS_KEY_ID,
        secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY
    })
})
const api = await OINONoSqlFactory.createApi(nosql, {
    apiName:   "entities",
    tableName: "myTable"
})
Copy

DynamoDB table schema

The target table must have:

• A HASH key of type String (any attribute name is accepted)
• A RANGE key of type String (any attribute name is accepted)

The actual attribute names are read from the table during validate() and stored on the instance. The OINO API field names (partitionKey, rowKey) will reflect the real DynamoDB attribute names once the backend is validated.

Two additional system attributes are managed automatically:

• _timestamp – ISO-8601 timestamp, set on every upsert
• _etag – UUID v4, regenerated on every upsert

All custom entity data is stored as top-level item attributes and serialised into OINONoSqlEntry.properties on read.

Static partition key

Set staticPartitionKey to scope all operations to a fixed partition key, allowing multiple logical tables to share one physical DynamoDB table:

const nosql = await OINONoSqlFactory.createNoSql({
    type:               "OINONoSqlAwsDynamoDB",
    url:                "",
    table:              "sharedTable",
    connectionStr:      process.env.DYNAMO_CONNECTION_STR,
    staticPartitionKey: "myLogicalTable"
})
Copy

Filter support

Filters on partitionKey are used to choose between Query (cheap, when an equality predicate on partitionKey is detected) and Scan (full-table).

All predicates except like are translated to DynamoDB FilterExpression (evaluated server-side, but billed at scan cost). like predicates are evaluated in-memory after the DynamoDB response is received.

DynamoDB operators supported: =, <>, <, <=, >, >=, attribute_exists, attribute_not_exists, AND, OR, NOT.