Research
Recent Trends in Malicious Packages Targeting Discord
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.
@nestjs/azure-database
Advanced tools
Readme
A progressive Node.js framework for building efficient and scalable server-side applications.
Azure Database (Table Storage, Cosmos DB - NoSQL) module for Nest framework (node.js)
You are reading documentation for version 3. If you are looking for version 2 documentation, click here. Please also note that version 2 is no longer maintained and will not receive any updates!
For Table Storage
For Cosmos DB (NoSQL ONLY)
$ npm i --save @nestjs/azure-database
.env
file with the following content:AZURE_STORAGE_CONNECTION_STRING=
IMPORTANT: Make sure to add your .env
file to your .gitignore! The .env
file MUST NOT be versioned on Git.
Make sure to include the following call to your main.ts
file:
if (process.env.NODE_ENV !== 'production') require('dotenv').config();
This line must be added before any other imports!
AzureTableStorageModule
will automatically read the AZURE_STORAGE_CONNECTION_STRING
environment variable and use it to connect to your Azure Storage account.Check out the Table Storage example project included in the sample folder
$ nest generate module event
event.dto.ts
:export class EventDTO {
name: string;
type: string;
}
event.entity.ts
and describe the entity model using plain JavaScript objects. The only requirement is to provide a partitionKey
and a rowKey
properties. For instance, the shape of the following entity:export class Event {
partitionKey: string; // required
rowKey: string; // required
name: string;
type: string;
}
AzureTableStorageModule
inside your Nest feature module event.module.ts
:import { Module } from '@nestjs/common';
import { AzureTableStorageModule } from '@nestjs/azure-database';
@Module({
imports: [AzureTableStorageModule.forFeature(Event)],
})
export class EventModule {}
You can optionally pass in the following arguments:
import { Module } from '@nestjs/common';
import { AzureTableStorageModule } from '@nestjs/azure-database';
@Module({
imports: [
AzureTableStorageModule.forFeature(Event, {
table: 'foobar',
createTableIfNotExists: true,
}),
],
})
export class EventModule {}
table: string
: The name of the table. If not provided, the name of the Event
entity will be used as a table namecreateTableIfNotExists: boolean
: Whether to automatically create the table if it doesn't exists or not:
true
the table will be created during the startup of the app.false
the table will not be created. You will have to create the table by yourself before querying it!$ nest generate service event
@InjectRepository(Event)
to get an instance of the Azure Repository
for the entity definition created earlier:import { InjectRepository, Repository } from '@nestjs/azure-database';
import { Injectable } from '@nestjs/common';
import { Event } from './event.entity';
@Injectable()
export class EventService {
constructor(
@InjectRepository(Event)
private readonly eventRepository: Repository<Event>,
) {}
}
The AzureTableStorageRepository
provides a list of public methods for managing various CRUD operations:
create(entity: T): Promise<T | null>
: creates a new entity.
async create(event: Event): Promise<Event> {
return await this.eventRepository.create(event);
}
find(partitionKey: string, rowKey: string): Promise<T>
: finds one entity using its partitionKey
and rowKey
.
async find(partitionKey: string, rowKey: string): Promise<Event> {
return await this.eventRepository.find(partitionKey, rowKey);
}
findAll(): Promise<T[]>
: finds all entities (NOTE: odata filters are not supported yet).
async findAll(): Promise<Event[]> {
return await this.eventRepository.findAll();
}
update(partitionKey: string, rowKey: string, entity: T): Promise<T>
: Updates an entity using a "merge" strategy.
async update(
partitionKey: string,
rowKey: string,
event: Event,
): Promise<Event> {
return await this.eventRepository.update(partitionKey, rowKey, event);
}
delete(partitionKey: string, rowKey: string): Promise<DeleteTableEntityResponse>
: Removes an entity from the table.
async delete(partitionKey: string, rowKey: string): Promise<void> {
await this.eventRepository.delete(partitionKey, rowKey);
}
.env
file with the following content:AZURE_COSMOS_DB_NAME=
AZURE_COSMOS_DB_ENDPOINT=
AZURE_COSMOS_DB_KEY=
IMPORTANT: Make sure to add your .env
file to your .gitignore! The .env
file MUST NOT be versioned on Git.
Make sure to include the following call to your main.ts
file:
if (process.env.NODE_ENV !== 'production') require('dotenv').config();
This line must be added before any other imports!
Note: Check out the CosmosDB example project included in the sample folder
$ nest generate module event
event.dto.ts
:export class EventDTO {
id?: string;
name: string;
type: string;
createdAt: Date;
}
event.entity.ts
and describe the entity model using the provided decorators:@CosmosPartitionKey(value: string)
: Represents the PartitionKey
of the entity (required).
@CosmosDateTime(value?: string)
: For DateTime values.
For instance, the shape of the following entity:
import { CosmosDateTime, CosmosPartitionKey } from '@nestjs/azure-database';
@CosmosPartitionKey('type')
export class Event {
name: string;
type: string;
@CosmosDateTime() createdAt: Date;
}
Will be automatically converted to:
{
"name": "NestJS Meetup",
"type": "Meetup",
"createdAt": "2019-11-15T17:05:25.427Z"
}
AzureCosmosDbModule
inside your Nest feature module event.module.ts
:import { AzureCosmosDbModule } from '@nestjs/azure-database';
import { Module } from '@nestjs/common';
import { Event } from './event.entity';
@Module({
imports: [
AzureCosmosDbModule.forRoot({
dbName: process.env.AZURE_COSMOS_DB_NAME,
endpoint: process.env.AZURE_COSMOS_DB_ENDPOINT,
key: process.env.AZURE_COSMOS_DB_KEY,
retryAttempts: 1,
}),
AzureCosmosDbModule.forFeature([{ dto: Event }]),
],
})
export class EventModule {}
$ nest generate service event
@InjectModel(Event)
to get an instance of the Azure Cosmos DB Container for the entity definition created earlier:import { InjectModel } from '@nestjs/azure-database';
import type { Container } from '@azure/cosmos';
import { Injectable } from '@nestjs/common';
import { Event } from './event.entity';
@Injectable()
export class EventService {
constructor(
@InjectModel(Event)
private readonly eventContainer: Container,
) {}
}
@InjectModel(Event)
will inject an Azure Cosmos DB Container
instance for the Event
entity. The Container
provides a list of public methods for managing the database.
IMPORTANT: Please note that the Container
instance is not a NestJS repository. It is the actual instance provided by the official Azure Cosmos DB SDK.
create(entity: T): Promise<T>
: creates a new entity.
async create(eventDto: EventDTO): Promise<Event> {
const { resource } = await this.eventContainer.items.create<Event>(
eventDto,
);
return resource;
}
Items.query<T>(query: string | SqlQuerySpec, options?: FeedOptions): QueryIterator<T>
: Queries the database using a SQL query.
QueryIterator<Event>.fetchAll(): Promise<FeedResponse<Event>>
: Fetches all the results of the query.
async getEvents(): Promise<Event[]> {
const querySpec = {
query: 'SELECT * FROM events',
};
const { resources } = await this.eventContainer.items
.query<Event>(querySpec)
.fetchAll();
return resources;
}
Item.replace<
T& Resource>(body:
T & Resource, options?: RequestOptions): Promise<ItemResponse<
T & Resource>>
: Replaces an item in the database.
async updateEvent(
id: string,
type: string,
eventData: EventDTO,
): Promise<Event> {
let { resource: item } = await this.eventContainer
.item(id, type)
.read<Event>();
item = {
...item,
...eventData,
};
const { resource: replaced } = await this.eventContainer
.item(id, type)
.replace(item);
return replaced;
}
Item.delete<T>(options?: RequestOptions): Promise<ItemResponse<T>>
: Deletes an item from the database.
async deleteEvent(id: string, type: string): Promise<Event> {
const { resource: deleted } = await this.eventContainer
.item(id, type)
.delete<Event>();
return deleted;
}
Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.
Nest is MIT licensed.
FAQs
The Azure Table Storage module for Nest framework (node.js)
We found that @nestjs/azure-database demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.
Security News
Socket CEO Feross Aboukhadijeh joins a16z partners to discuss how modern, sophisticated supply chain attacks require AI-driven defenses and explore the challenges and solutions in leveraging AI for threat detection early in the development life cycle.
Security News
NIST's new AI Risk Management Framework aims to enhance the security and reliability of generative AI systems and address the unique challenges of malicious AI exploits.