README

Extends TYPO3 to support MongoDB as a database backend.

📑 Table of Contents

• General Info
• Getting Started
  • Prerequisites
  • Installation
  • Configuration
• Usage
  • Basic Usage
  • Full Example
• Charts
• Documentation
• Support
• Authors
• License

General Info

This TYPO3 extension provides a MongoDB driver that allows you to connect and interact with MongoDB databases directly from your TYPO3 installation.

Keywords: TYPO3 extension MongoDB driver database

Getting Started

Prerequisites

Installation

1. Install the extension via Composer:

   composer require twoh/twoh_mongodb_driver

2. Activate the extension in the TYPO3 Extension Manager.

Configuration

Add the driver connection settings to your config/system/settings.php or config/system/additional.php:

$GLOBALS['TYPO3_CONF_VARS']['DRIVER']['MongoDB'] = [
    'host'     => getenv('TOOL_DB_HOST'),
    'dbname'   => getenv('TOOL_DB_DATABASE'),
    'user'     => getenv('TOOL_DB_USERNAME'),
    'password' => getenv('TOOL_DB_PASSWORD'),
    'port'     => getenv('TOOL_DB_PORT'),
];

Usage

Basic Usage

Access the ConnectionPool object to execute your queries:

Namespace: TWOH\TwohMongodbDriver\Adapter\MongodbConnectionPoolAdapter

$mongodbConnectionPoolAdapter = GeneralUtility::makeInstance(MongodbConnectionPoolAdapter::class);

$mongodbConnectionPoolAdapter->getConnectionPool()->selectDocuments(
    $collectionName, 
    $filter,
    $options
);

Full Example

The following example demonstrates how to query MongoDB and return the results to your view:

protected MongodbConnectionPoolAdapter $mongodbConnectionPoolAdapter;

public function __construct(
    protected MongodbConnectionPoolAdapter $mongodbConnectionPoolAdapter
) {
}

public function indexAction(
    ServerRequestInterface $request,
    ModuleTemplate $view
): ResponseInterface {
    $view->assignMultiple([
        'users' => $this->mongodbConnectionPoolAdapter->getConnectionPool()->selectDocuments(
            'user',
            [
                'uuid' => 'user1',
            ],
            [
                'limit' => 5,
                'projection' => [
                    'uuid' => 1,
                    'username' => 1,
                    'email' => 1,
                    'name' => 1,
                    'pageInteractions' => 1,
                ],
            ],
        )
    ]);
    
    return $view->renderResponse('AdminModule/Index');
}

Charts

This extension integrates charts via Chart.js.

Documentation

📖 ConnectionPool Functions – Detailed documentation of all available ConnectionPool methods.

📚 Official Documentation – Full documentation on docs.typo3.org.

Support

• 🐛 Report Issues – Found a bug? Let us know!
• 📦 Source Code – View the source on GitHub.
• 💖 Sponsor this Project – Support development with a GitHub Sponsorship!

If you find this extension useful and want to support its continued development, please consider becoming a sponsor. Your support helps maintain and improve this project, add new features, and keep it compatible with the latest TYPO3 versions. Every contribution, no matter how small, makes a difference!

Authors

License

This project is licensed under the GPL-2.0-or-later license. See the LICENSE file for details.