cassandraorm-js
Version:
The most advanced ORM for Apache Cassandra and ScyllaDB with native TypeScript support, AI/ML integration, and enterprise-grade features
65 lines (42 loc) • 1.19 kB
Markdown
API Reference - CassandraORM JS
# CassandraORM
## Constructor
```typescript
new CassandraORM(options: ConnectionOptions)
```
## Methods
### `connect(): Promise<void>`
Connects to the Cassandra cluster.
### `model(name: string, schema: Schema, options?: ModelOptions): Model`
Defines a new model.
### `uuid(): string`
Generates a UUID v4.
### `batch(): BatchQuery`
Creates a batch operation.
# Model
## Static Methods
### `create(data: object): Promise<ModelInstance>`
Creates a new instance.
### `find(query: object): Promise<ModelInstance[]>`
Finds records.
### `findOne(query: object): Promise<ModelInstance | null>`
Finds a single record.
### `update(query: object, data: object): Promise<void>`
Updates records.
### `delete(query: object): Promise<void>`
Deletes records.
## Instance Methods
### `save(): Promise<void>`
Saves the instance.
### `remove(): Promise<void>`
Removes the instance.
# Query Operators
- `$eq` - Equal
- `$gt` - Greater than
- `$gte` - Greater than or equal
- `$lt` - Less than
- `$lte` - Less than or equal
- `$in` - In array
# 🌍 Languages
- [English](api-reference.md) (current)
- [Português](api-reference.pt.md)