https://github.com/chris-armstrong/dynamodb-size-js

Calculate DynamoDB object size
https://github.com/chris-armstrong/dynamodb-size-js

Last synced: 11 days ago
JSON representation

Calculate DynamoDB object size

• Host: GitHub
• URL: https://github.com/chris-armstrong/dynamodb-size-js
• Owner: chris-armstrong
• Created: 2020-05-22T08:34:44.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-10-18T05:06:05.000Z (about 1 year ago)
• Last Synced: 2024-09-19T18:18:06.721Z (about 2 months ago)
• Language: JavaScript
• Size: 1.6 MB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-dynamodb - dynamodb-size

README

        
# dynamodb-size

A DynamoDB size calculator, based on [this article](https://medium.com/@zaccharles/calculating-a-dynamodb-items-size-and-consumed-capacity-d1728942eb7c)

Works on your objects before DynamoDB object-structure conversion (i.e. those you'd pass to the `DocumentClient` interface, not the `DynamoDB` interface`).

You may find this useful for:

* Identifying objects that are too big to store in DynamoDB (such as when using BatchWriteItem)

* Estimating the storage cost of a large number of objects before a bulk-import or data migration

* Optimising the size of objects in a busy table

*No guarantees that this is accurate, correct, complete or fully tested - it should only be used for estimations.*

## Installation

```sh

npm install dynamodb-size

```

## Usage

```javascript

const calculateDynamoDBSize = require('dynamodb-size');

const myObject = {

  aString: {

    value1: 134,

    test: false,

  },

};

const sizeOfMyObject = calculateDynamoDBSize(myObject);

```

The size is given in estimated bytes.

## License

Copyright 2020 Chris Armstrong

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.