Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tdameritrade/botbuilder-storage-postgres

Botbuilder adapter for Postgres NoSQL storage.
https://github.com/tdameritrade/botbuilder-storage-postgres

bot-builder javascript-library nosql postgres storage-adapter

Last synced: about 2 months ago
JSON representation

Botbuilder adapter for Postgres NoSQL storage.

Host: GitHub
URL: https://github.com/tdameritrade/botbuilder-storage-postgres
Owner: TDAmeritrade
License: mit
Created: 2019-06-20T16:28:52.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-09-18T16:42:50.000Z (3 months ago)
Last Synced: 2024-11-06T08:02:49.380Z (about 2 months ago)
Topics: bot-builder, javascript-library, nosql, postgres, storage-adapter
Language: JavaScript
Size: 1.65 MB
Stars: 14
Watchers: 4
Forks: 7
Open Issues: 10
Metadata Files:
- Readme: README.md
- Contributing: Contributing.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        [![Github All Releases](https://img.shields.io/github/downloads/TDAmeritrade/botbuilder-storage-postgres/total.svg)][![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FTDAmeritrade%2Fbotbuilder-storage-postgres.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2FTDAmeritrade%2Fbotbuilder-storage-postgres?ref=badge_shield)

() [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Twitter](https://img.shields.io/twitter/url/https/github.com/TDAmeritrade/botbuilder-storage-postgres.svg?style=social)](https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2FTDAmeritrade%2Fbotbuilder-storage-postgres) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FTDAmeritrade%2Fbotbuilder-storage-postgres.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2FTDAmeritrade%2Fbotbuilder-storage-postgres?ref=badge_large)

# State Storage for Bot Framework using Postgres

This project provides a Postgres storage mechanism for [Bot Framework-JS SDK V4](https://github.com/Microsoft/botbuilder-js).

It allows you to store bot state in Postgres, so that you can scale out your bot, and be more resilient to bot server failures.

For more information about the botbuilder community, please visit [the botbuilder community project](https://github.com/BotBuilderCommunity/botbuilder-community-js).

## Requirements

-   [NodeJS](https://nodejs.org/en/) 10.x is a requirement to install dependencies, build and run tests.

-   Postgres database.

## Installation

```bash

npm install botbuilder-storage-postgres

```

## Sample Usage

```JavaScript

const postgresStorage = new PostgresStorage({

  uri : process.env.POSTGRES_URI

});

const conversationState = new ConversationState(postgresStorage);

```

Where `POSTGRES_URI` is set in `.env` or your secrets store of choice according to LibPQ Connection String standards. E.g.

`postgresql://[user[:password]@][netloc][:port][,...][/dbname][?param1=value1&...]`

**NOTE** Make sure to encode special characters in the password. More details on [percent encoding](https://en.wikipedia.org/wiki/Percent-encoding#Reserved_characters)

### Methods

The `conversationState` declared above would have three methods attached: 

* [read](https://github.com/TDAmeritrade/botbuilder-storage-postgres/blob/99e3cb39e27abf18c2e187ee572652a80e99862d/src/PostgresStorage.ts#L102). Signature: `async read(stateKeys: string[]): Promise`

* [write](https://github.com/TDAmeritrade/botbuilder-storage-postgres/blob/99e3cb39e27abf18c2e187ee572652a80e99862d/src/PostgresStorage.ts#L117). Signature: `async write(changes: StoreItems): Promise`

* [delete](https://github.com/TDAmeritrade/botbuilder-storage-postgres/blob/99e3cb39e27abf18c2e187ee572652a80e99862d/src/PostgresStorage.ts#L156). Signature: `async delete(keys: string[]): Promise`

For information about the types expected and returned with each method, please check out the source and read the [Microsoft Storage Interface](https://docs.microsoft.com/en-us/javascript/api/botbuilder-core/storage?view=botbuilder-ts-latest) documentation. 

## Configuration Options

| Field        | Description                                                    | Value      |

| ------------ | -------------------------------------------------------------- | ---------- |

| `uri`        | The Postgres connection URI                                    | _Required_ |

| `collection` | The name you'd like given to the table the bot will reference. | _Optional_ |

| `logging`    | Whether or not you want logging of transactions enabled.       | _Optional_ |

> ⚠ Caution: you **should not store postgres URI in code!** Get the `uri` from a configuration such as environment variable or a secrets store in your environment. It may contain sensitive password in the clear and should **never be stored in code**!

See [Postgres Connection URI format](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING) in the official documentation to learn more about the connection `uri` parameter value.

---

\*

-   botbuilder-storage-postgres

-   Copyright 2019 TD Ameritrade. Released under the terms of the MIT license.

-   ***