Skip to content

Commit 6b139aa

Browse files
GromNaNGromNaN
committed
Add mentions to MongoDB in the docs
1 parent 8f1a3d0 commit 6b139aa

File tree

7 files changed

+115
-2
lines changed

7 files changed

+115
-2
lines changed

Diff for: ‎authentication.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Want to get started fast? Install a [Laravel application starter kit](/docs/{{ve
5353
<a name="introduction-database-considerations"></a>
5454
### Database Considerations
5555

56-
By default, Laravel includes an `App\Models\User` [Eloquent model](/docs/{{version}}/eloquent) in your `app/Models` directory. This model may be used with the default Eloquent authentication driver. If your application is not using Eloquent, you may use the `database` authentication provider which uses the Laravel query builder.
56+
By default, Laravel includes an `App\Models\User` [Eloquent model](/docs/{{version}}/eloquent) in your `app/Models` directory. This model may be used with the default Eloquent authentication driver. If your application is not using Eloquent, you may use the `database` authentication provider which uses the Laravel query builder. If your application is using MongoDB, see the [User Authentication](https://www.mongodb.com/docs/drivers/php/laravel-mongodb/current/user-authentication/) page in the `mongodb/laravel-mongodb` package's documentation for additional information.
5757

5858
When building the database schema for the `App\Models\User` model, make sure the password column is at least 60 characters in length. Of course, the `users` table migration that is included in new Laravel applications already creates a column that exceeds this length.
5959

Diff for: ‎cache.md

+7
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,13 @@ In addition, you should ensure that values are provided for the DynamoDB cache s
111111
],
112112
```
113113

114+
<a name="mongodb"></a>
115+
#### MongoDB
116+
117+
If you are using MongoDB, a `mongodb` cache driver is provided by the `mongodb/laravel-mongodb` package and can be configured using a `mongodb` database connection. MongoDB supports TTL indexes, which can be used to automatically clear expired cache items.
118+
119+
For more information on configuring MongoDB, see the [Cache and Locks](https://www.mongodb.com/docs/drivers/php/laravel-mongodb/current/cache/) page in its documentation.
120+
114121
<a name="cache-usage"></a>
115122
## Cache Usage
116123

Diff for: ‎database.md

+2
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ Almost every modern web application interacts with a database. Laravel makes int
2727

2828
</div>
2929

30+
Additionally, MongoDB is supported via the `mongodb/laravel-mongodb` package, which is officially maintained by MongoDB. See the [Laravel MongoDB](https://www.mongodb.com/docs/drivers/php/laravel-mongodb/) documentation for more information.
31+
3032
<a name="configuration"></a>
3133
### Configuration
3234

Diff for: ‎documentation.md

+1
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@
6464
- [Migrations](/docs/{{version}}/migrations)
6565
- [Seeding](/docs/{{version}}/seeding)
6666
- [Redis](/docs/{{version}}/redis)
67+
- [MongoDB](/docs/{{version}}/mongodb)
6768
- ## Eloquent ORM
6869
- [Getting Started](/docs/{{version}}/eloquent)
6970
- [Relationships](/docs/{{version}}/eloquent-relationships)

Diff for: ‎mongodb.md

+99
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
# MongoDB
2+
3+
- [Introduction](#introduction)
4+
- [Installation](#installation)
5+
- [Starting a MongoDB server](#starting-a-mongodb-server)
6+
- [MongoDB Driver](#mongodb-driver)
7+
- [Install the Laravel MongoDB package](#install-the-laravel-mongodb-package)
8+
- [Configuration](#configuration)
9+
- [Features](#features)
10+
11+
<a name="introduction"></a>
12+
## Introduction
13+
14+
[MongoDB](https://www.mongodb.com/resources/products/fundamentals/why-use-mongodb) is one of the most popular NoSQL document-oriented database, used for its high write load (useful for analytics or IoT) and high availability (easy to set replica sets with automatic failover). It can also shard the database easily for horizontal scalability and has a powerful query language for doing aggregation, text search or geospatial queries. Instead of storing data in tables of rows or columns like SQL databases, each record in a MongoDB database is a document described in BSON, a binary representation of the data. Applications can then retrieve this information in a JSON format. It supports a wide variety of data types, including documents, arrays, embedded documents, and binary data.
15+
16+
Before using MongoDB with Laravel, we recommend installing and using the `mongodb/laravel-mongodb` package via Composer. While MongoDB is natively supported by PHP through the MongoDB driver, the [Laravel MongoDB](https://www.mongodb.com/docs/drivers/php/laravel-mongodb/) package provides a richer integration with Eloquent and other Laravel features.
17+
18+
```shell
19+
composer require mongodb/laravel-mongodb
20+
```
21+
22+
<a name="installation"></a>
23+
## Installation
24+
25+
<a name="starting-a-mongodb-server"></a>
26+
#### Starting a MongoDB server
27+
28+
The MongoDB Community Server can be used to create a Laravel application. It is available for installation in Windows, macOS, Linux, or as Docker container. Read how to [Install MongoDB Community Edition](https://docs.mongodb.com/manual/administration/install-community/).
29+
30+
The connection string for the MongoDB server can be set in the `.env` file:
31+
32+
```
33+
MONGODB_URI=mongodb://localhost:27017
34+
MONGODB_DATABASE=laravel_app
35+
```
36+
37+
For hosting MongoDB in the cloud, consider using [MongoDB Atlas](https://www.mongodb.com/cloud/atlas).
38+
To access a MongoDB Atlas cluster locally from your application, you will need to [add your own IP address in the cluster's network settings](https://www.mongodb.com/docs/atlas/security/add-ip-address-to-list/) to the project's IP Access List.
39+
40+
The connection string for MongoDB Atlas can be set in the `.env` file:
41+
42+
```
43+
MONGODB_URI=mongodb+srv://<username>:<password>@<cluster>.mongodb.net/<dbname>?retryWrites=true&w=majority
44+
MONGODB_DATABASE=laravel_app
45+
```
46+
47+
<a name="mongodb-driver"></a>
48+
#### MongoDB Driver
49+
50+
To connect to a MongoDB database, the `mongodb` PHP extension is required. This extension can be installed using PECL:
51+
52+
```shell
53+
pecl install mongodb
54+
```
55+
56+
Read the [MongoDB PHP extension installation instructions](https://www.php.net/manual/en/mongodb.installation.php) for more information.
57+
58+
<a name="install-the-laravel-mongodb-package"></a>
59+
#### Install the Laravel MongoDB package
60+
61+
Use Composer to install the Laravel MongoDB package:
62+
63+
```shell
64+
composer require mongodb/laravel-mongodb
65+
```
66+
67+
> [!NOTE]
68+
> This installation of the package will fail if the `mongodb` PHP extension is not installed. The PHP configuration can differ between the CLI and the web server, so ensure the extension is enabled in both configurations.
69+
70+
<a name="configuration"></a>
71+
## Configuration
72+
73+
You may configure your MongoDB connection via the `config/database.php` configuration file.
74+
Within this file, you can add a `mongodb` connection using the `mongodb` driver:
75+
76+
```php
77+
'connections' => [
78+
'mongodb' => [
79+
'driver' => 'mongodb',
80+
'dsn' => env('MONGODB_URI', 'mongodb://localhost:27017'),
81+
'database' => env('MONGODB_DATABASE', 'laravel_app'),
82+
],
83+
],
84+
```
85+
86+
<a name="features"></a>
87+
## Features
88+
89+
Once your configuration is complete, you can use the `mongodb` connection in your application:
90+
91+
- [Using Eloquent](https://www.mongodb.com/docs/drivers/php/laravel-mongodb/current/eloquent-models/), models can be stored in MongoDB collections. In addition to the standard Eloquent features, the Laravel MongoDB package provides additional features such as embedded relationships. The package also provides direct access to the MongoDB driver, which can be used to execute operations such as raw queries and aggregation pipelines.
92+
- [Write complex queries](https://www.mongodb.com/docs/drivers/php/laravel-mongodb/current/query-builder/) using the query builder.
93+
- [Using the Cache](https://www.mongodb.com/docs/drivers/php/laravel-mongodb/current/cache/), the `mongodb` cache driver is optimized to use MongoDB features such as TTL indexes to automatically clear expired cache entries.
94+
- Using the Session with Laravel's `cache` and the `mongodb` cache driver.
95+
- [Using the Queue](https://www.mongodb.com/docs/drivers/php/laravel-mongodb/current/queues/) with the `mongodb` queue driver.
96+
- [Storing files in GridFS](https://www.mongodb.com/docs/drivers/php/laravel-mongodb/current/gridfs/), by way of the [GridFS Adapter for Flysystem](https://flysystem.thephpleague.com/docs/adapter/gridfs/).
97+
- Most third party packages using a database connection or Eloquent can be used with MongoDB.
98+
99+
Refer to the [**Quick Start**](https://www.mongodb.com/docs/drivers/php/laravel-mongodb/current/quick-start/) guide to connect a Laravel application to MongoDB, and perform read/write operations on the data.

Diff for: ‎queues.md

+1
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,7 @@ The following dependencies are needed for the listed queue drivers. These depend
151151
- Amazon SQS: `aws/aws-sdk-php ~3.0`
152152
- Beanstalkd: `pda/pheanstalk ~5.0`
153153
- Redis: `predis/predis ~2.0` or phpredis PHP extension
154+
- MongoDB: `mongodb/laravel-mongodb`, read more about [Laravel Queue with MongoDB](https://www.mongodb.com/docs/drivers/php/laravel-mongodb/current/queues/)
154155

155156
</div>
156157

Diff for: ‎session.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ If you need to regenerate the session ID and remove all data from the session in
245245
## Session Blocking
246246

247247
> [!WARNING]
248-
> To utilize session blocking, your application must be using a cache driver that supports [atomic locks](/docs/{{version}}/cache#atomic-locks). Currently, those cache drivers include the `memcached`, `dynamodb`, `redis`, `database`, `file`, and `array` drivers. In addition, you may not use the `cookie` session driver.
248+
> To utilize session blocking, your application must be using a cache driver that supports [atomic locks](/docs/{{version}}/cache#atomic-locks). Currently, those cache drivers include the `memcached`, `dynamodb`, `redis`, `mongodb` (included in `mongodb/laravel-mongodb` package), `database`, `file`, and `array` drivers. In addition, you may not use the `cookie` session driver.
249249
250250
By default, Laravel allows requests using the same session to execute concurrently. So, for example, if you use a JavaScript HTTP library to make two HTTP requests to your application, they will both execute at the same time. For many applications, this is not a problem; however, session data loss can occur in a small subset of applications that make concurrent requests to two different application endpoints which both write data to the session.
251251

@@ -294,6 +294,9 @@ If none of the existing session drivers fit your application's needs, Laravel ma
294294
> [!NOTE]
295295
> Laravel does not ship with a directory to contain your extensions. You are free to place them anywhere you like. In this example, we have created an `Extensions` directory to house the `MongoSessionHandler`.
296296
297+
> [!NOTE]
298+
> We use MongoDB as an example, but if you are looking for a MongoDB session driver, you can use the `cache` session driver with a `mongodb` cache store. Read more about the [MongoDB Cache Driver](https://www.mongodb.com/docs/drivers/php/laravel-mongodb/current/cache/).
299+
297300
Since the purpose of these methods is not readily understandable, let's quickly cover what each of the methods do:
298301

299302
<div class="content-list" markdown="1">

0 commit comments

Comments
 (0)