Using JavaScript Map to Create an In-Memory Database

Using JavaScript Map to Create an In-Memory Database
Photo by Samsung Memory / Unsplash

In JavaScript, the Map object is an incredibly powerful data structure that can be used to create a lightweight, in-memory database. With its ability to store key-value pairs, it offers advantages such as faster lookups, efficient iteration, and flexibility over plain objects. In this blog post, we’ll explore how to use the JavaScript Map object to build an in-memory database, and why it's an ideal choice for handling temporary or small-scale datasets.

Why Use Map Over Plain JavaScript Objects?

Before diving into implementation, let’s explore why Map is a superior choice over plain JavaScript objects when building an in-memory database:

Key Benefits of Map:

  1. Preserves Insertion Order: Unlike plain objects, Map maintains the order of entries based on insertion, making it suitable for ordered datasets.
  2. Efficient Key Management: Map allows for keys of any type, including objects and functions, providing flexibility that plain objects lack (which only allow strings or symbols as keys).
  3. Fast Lookups: Map offers faster lookups when dealing with a large dataset, making it ideal for handling in-memory data.
  4. Built-in Methods: Map comes with several built-in methods like set(), get(), and has() for easy manipulation and access.

Implementing an In-Memory Database Using Map

Let’s break down the steps to implement a basic in-memory database using JavaScript’s Map object.

1. Setting Up the In-Memory Database

To start, we’ll initialize the database as a new Map instance. Each entry in the map will represent a record in the database.

class InMemoryDatabase {
    constructor() {
        this.db = new Map();  // Initialize the Map
    }
}

2. Creating CRUD Operations

Next, let’s implement the basic CRUD (Create, Read, Update, Delete) operations for our in-memory database.

Create: Inserting Records

We’ll use the set() method to insert a new record into the database. Each record will have a unique ID.

createRecord(id, data) {
    if (this.db.has(id)) {
        throw new Error("Record already exists with this ID");
    }
    this.db.set(id, data);  // Add record to the Map
}

Read: Retrieving Records

The get() method allows us to retrieve a record by its ID. If the record doesn’t exist, we return null.

readRecord(id) {
    return this.db.get(id) || null;  // Fetch record by ID
}

Update: Modifying Existing Records

To update an existing record, we can use the set() method again. First, we check if the record exists using has().

updateRecord(id, newData) {
    if (!this.db.has(id)) {
        throw new Error("No record found with this ID");
    }
    this.db.set(id, newData);  // Update the record
}

Delete: Removing Records

The delete() method allows us to remove a record from the database by its ID.

deleteRecord(id) {
    if (!this.db.has(id)) {
        throw new Error("No record found with this ID");
    }
    this.db.delete(id);  // Remove the record from the Map
}

3. Additional Features: Iteration and Searching

One of the great features of Map is its ability to iterate over entries using for...of or forEach(). This is useful for implementing search functionality or retrieving all records.

Example: Retrieving All Records

We can implement a method to retrieve all entries from the in-memory database.

getAllRecords() {
    const records = [];
    this.db.forEach((value, key) => {
        records.push({ id: key, data: value });
    });
    return records;
}

Example: Searching for Records

We can implement a simple search function to find records based on a condition.

searchRecords(callback) {
    const results = [];
    for (let [id, data] of this.db) {
        if (callback(data)) {
            results.push({ id, data });
        }
    }
    return results;
}

Complete In-Memory Database Example

Here’s the full implementation of the in-memory database using the Map object:

class InMemoryDatabase {
    constructor() {
        this.db = new Map();  // Initialize Map as the in-memory database
    }

    createRecord(id, data) {
        if (this.db.has(id)) {
            throw new Error("Record already exists with this ID");
        }
        this.db.set(id, data);
    }

    readRecord(id) {
        return this.db.get(id) || null;
    }

    updateRecord(id, newData) {
        if (!this.db.has(id)) {
            throw new Error("No record found with this ID");
        }
        this.db.set(id, newData);
    }

    deleteRecord(id) {
        if (!this.db.has(id)) {
            throw new Error("No record found with this ID");
        }
        this.db.delete(id);
    }

    getAllRecords() {
        const records = [];
        this.db.forEach((value, key) => {
            records.push({ id: key, data: value });
        });
        return records;
    }

    searchRecords(callback) {
        const results = [];
        for (let [id, data] of this.db) {
            if (callback(data)) {
                results.push({ id, data });
            }
        }
        return results;
    }
}

Example Usage:

const db = new InMemoryDatabase();

// Creating records
db.createRecord(1, { name: "John Doe", age: 30 });
db.createRecord(2, { name: "Jane Smith", age: 25 });

// Reading a record
console.log(db.readRecord(1));  // Output: { name: "John Doe", age: 30 }

// Updating a record
db.updateRecord(1, { name: "John Doe", age: 31 });

// Deleting a record
db.deleteRecord(2);

// Retrieving all records
console.log(db.getAllRecords());  // Output: [ { id: 1, data: { name: 'John Doe', age: 31 } } ]

Why Use Map for an In-Memory Database?

1. Efficiency:

Map provides fast lookups, additions, and deletions. It’s optimized for performance and handles large datasets efficiently, especially when keys are not simple strings.

2. Key Flexibility:

With Map, keys can be of any data type, including objects and functions, making it more versatile than plain objects.

3. Order Preservation:

Unlike objects, Map maintains the insertion order, making it easier to track data chronologically or retrieve records in the same order they were inserted.

Conclusion: Leveraging JavaScript Map for In-Memory Databases

The Map object in JavaScript offers a powerful, flexible, and efficient way to implement an in-memory database. With its ability to manage key-value pairs, perform fast lookups, and maintain insertion order, Map is ideal for scenarios where you need temporary storage or a lightweight database solution. By mastering Map and its features, you can easily build scalable applications with better performance.

Subscribe to codingwithalex

Don’t miss out on the latest issues. Sign up now to get access to the library of members-only issues.
[email protected]
Subscribe