@nerdware/ddb-single-table
Version:
A schema-based DynamoDB modeling tool, high-level API, and type-generator built to supercharge single-table designs!⚡
89 lines (88 loc) • 3.92 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.createTable = void 0;
const client_dynamodb_1 = require("@aws-sdk/client-dynamodb");
const errors_js_1 = require("../utils/errors.js");
/**
* [`CreateTable`][create-table-docs] operation wrapper which uses the provided `tableKeysSchema`
* to form the `CreateTable` arguments listed below. All other `CreateTable` arguments can be
* provided to this method.
*
* - `AttributeDefinitions`
* - `KeySchema`
* - `GlobalSecondaryIndexes`
* - `LocalSecondaryIndexes`
*
* [create-table-docs]: https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_CreateTable.html
*
* @param createTableArgs `CreateTable` arguments to pass to the AWS SDK.
* @returns The response from the `CreateTable` operation.
* @throws {DdbSingleTableError} if `BillingMode` is "PAY_PER_REQUEST" and `ProvisionedThroughput` is provided.
*/
const createTable = async function (createTableArgs = {}) {
// If createTableArgs were provided, provide some minor early validation:
if (createTableArgs.BillingMode === client_dynamodb_1.BillingMode.PAY_PER_REQUEST
&& !!createTableArgs.ProvisionedThroughput) {
throw new errors_js_1.DdbSingleTableError(`Invalid "createTable" args: "ProvisionedThroughput" should not be `
+ `provided when "BillingMode" is "${client_dynamodb_1.BillingMode.PAY_PER_REQUEST}".`);
}
const AttributeDefinitions = [];
const KeySchema = [];
const GlobalSecondaryIndexes = [];
const LocalSecondaryIndexes = [];
// Make `CreateTable` args from the `tableKeysSchema` provided to the `Table` constructor
for (const keyAttrName in this.tableKeysSchema) {
const keyAttrConfig = this.tableKeysSchema[keyAttrName];
const { type: keyAttrType, isHashKey: isTableHashKey = false, isRangeKey: isTableRangeKey = false, index, } = keyAttrConfig;
AttributeDefinitions.push({
AttributeName: keyAttrName,
AttributeType: keyAttrType === "string" ? "S" : keyAttrType === "number" ? "N" : "B",
// keys can only be strings, numbers, or binary
});
// Table hash+range keys
if (isTableHashKey || isTableRangeKey) {
KeySchema.push({
AttributeName: keyAttrName,
KeyType: isTableHashKey === true ? "HASH" : "RANGE",
});
}
// Indexes
if (index) {
// Determine GSI or LSI, then push to the respective array
const indexArray = index.global === true ? GlobalSecondaryIndexes : LocalSecondaryIndexes;
indexArray.push({
IndexName: index.name,
KeySchema: [
{
AttributeName: keyAttrName,
KeyType: "HASH",
},
...(index.rangeKey ? [{ AttributeName: index.rangeKey, KeyType: "RANGE" }] : []),
],
Projection: {
ProjectionType: !index.project // if undefined or false, default "KEYS_ONLY"
? "KEYS_ONLY"
: index.project === true
? "ALL"
: "INCLUDE",
...(Array.isArray(index.project) && { NonKeyAttributes: index.project }),
},
...(!!index.throughput && {
ProvisionedThroughput: {
ReadCapacityUnits: index.throughput.read,
WriteCapacityUnits: index.throughput.write,
},
}),
});
}
}
// Create the table
return await this.ddb.createTable({
...createTableArgs,
AttributeDefinitions,
KeySchema,
GlobalSecondaryIndexes,
LocalSecondaryIndexes,
});
};
exports.createTable = createTable;