8000 chore: revert back readme changes · mongodb/laravel-mongodb@d365697 · GitHub
[go: up one dir, main page]
Skip to content

Commit d365697

Browse files
divinedivine
committed
chore: revert back readme changes
1 parent b70a4d5 commit d365697

File tree

1 file changed

+66
-56
lines changed

1 file changed

+66
-56
lines changed

‎README.md

Lines changed: 66 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,54 @@
1-
# Laravel MongoDB
1+
Laravel MongoDB
2+
===============
23

34
[![Latest Stable Version](http://img.shields.io/github/release/jenssegers/laravel-mongodb.svg)](https://packagist.org/packages/jenssegers/mongodb)
45
[![Total Downloads](http://img.shields.io/packagist/dm/jenssegers/mongodb.svg)](https://packagist.org/packages/jenssegers/mongodb)
56
[![Build Status](https://img.shields.io/github/workflow/status/jenssegers/laravel-mongodb/CI)](https://github.com/jenssegers/laravel-mongodb/actions)
67
[![codecov](https://codecov.io/gh/jenssegers/laravel-mongodb/branch/master/graph/badge.svg)](https://codecov.io/gh/jenssegers/laravel-mongodb/branch/master)
78
[![Donate](https://img.shields.io/badge/donate-paypal-blue.svg)](https://www.paypal.me/jenssegers)
89

9-
This package adds functionalities to the Eloquent model and Query builder for MongoDB, using the original Laravel API. _This library extends the original Laravel classes, so it uses exactly the same methods._
10-
11-
- [Laravel MongoDB](#laravel-mongodb)
12-
- [Installation](#installation)
13-
- [Laravel version Compatibility](#laravel-version-compatibility)
14-
- [Laravel](#laravel)
15-
- [Lumen](#lumen)
16-
- [Non-Laravel projects](#non-laravel-projects)
17-
- [Testing](#testing)
18-
- [Database Testing](#database-testing)
19-
- [Configuration](#configuration)
20-
- [Eloquent](#eloquent)
21-
- [Extending the base model](#extending-the-base-model)
22-
- [Extending the Authenticable base model](#extending-the-authenticable-base-model)
23-
- [Soft Deletes](#soft-deletes)
24-
- [Guarding attributes](#guarding-attributes)
25-
- [Dates](#dates)
26-
- [Basic Usage](#basic-usage)
27-
- [MongoDB-specific operators](#mongodb-specific-operators)
28-
- [MongoDB-specific Geo operations](#mongodb-specific-geo-operations)
29-
- [Inserts, updates and deletes](#inserts-updates-and-deletes)
30-
- [MongoDB specific operations](#mongodb-specific-operations)
31-
- [Relationships](#relationships)
32-
- [Basic Usage](#basic-usage-1)
33-
- [belongsToMany and pivots](#belongstomany-and-pivots)
34-
- [EmbedsMany Relationship](#embedsmany-relationship)
35-
- [EmbedsOne Relationship](#embedsone-relationship)
36-
- [Query Builder](#query-builder)
37-
- [Basic Usage](#basic-usage-2)
38-
- [Available operations](#available-operations)
39-
- [Transactions](#transactions)
40-
- [Schema](#schema)
41-
- [Basic Usage](#basic-usage-3)
42-
- [Geospatial indexes](#geospatial-indexes)
43-
- [Extending](#extending)
44-
- [Cross-Database Relationships](#cross-database-relationships)
45-
- [Authentication](#authentication)
46-
- [Queues](#queues)
47-
- [Laravel specific](#laravel-specific)
48-
- [Lumen specific](#lumen-specific)
49-
- [Upgrading](#upgrading)
50-
- [Upgrading from version 2 to 3](#upgrading-from-version-2-to-3)
51-
- [Security contact information](#security-contact-information)
10+
This package adds functionalities to the Eloquent model and Query builder for MongoDB, using the original Laravel API. *This library extends the original Laravel classes, so it uses exactly the same methods.*
11+
- [Laravel MongoDB](#laravel-mongodb)
12+
- [Installation](#installation)
13+
- [Laravel version Compatibility](#laravel-version-compatibility)
14+
- [Laravel](#laravel)
15+
- [Lumen](#lumen)
16+
- [Non-Laravel projects](#non-laravel-projects)
17+
- [Testing](#testing)
18+
- [Database Testing](#database-testing)
19+
- [Configuration](#configuration)
20+
- [Eloquent](#eloquent)
21+
- [Extending the base model](#extending-the-base-model)
22+
- [Extending the Authenticable base model](#extending-the-authenticable-base-model)
23+
- [Soft Deletes](#soft-deletes)
24+
- [Guarding attributes](#guarding-attributes)
25+
- [Dates](#dates)
26+
- [Basic Usage](#basic-usage)
27+
- [MongoDB-specific operators](#mongodb-specific-operators)
28+
- [MongoDB-specific Geo operations](#mongodb-specific-geo-operations)
29+
- [Inserts, updates and deletes](#inserts-updates-and-deletes)
30+
- [MongoDB specific operations](#mongodb-specific-operations)
31+
- [Relationships](#relationships)
32+
- [Basic Usage](#basic-usage-1)
33+
- [belongsToMany and pivots](#belongstomany-and-pivots)
34+
- [EmbedsMany Relationship](#embedsmany-relationship)
35+
- [EmbedsOne Relationship](#embedsone-relationship)
36+
- [Query Builder](#query-builder)
37+
- [Basic Usage](#basic-usage-2)
38+
- [Available operations](#available-operations)
39+
- [Transactions](#transactions)
40+
- [Schema](#schema)
41+
- [Basic Usage](#basic-usage-3)
42+
- [Geospatial indexes](#geospatial-indexes)
43+
- [Extending](#extending)
44+
- [Cross-Database Relationships](#cross-database-relationships)
45+
- [Authentication](#authentication)
46+
- [Queues](#queues)
47+
- [Laravel specific](#laravel-specific)
48+
- [Lumen specific](#lumen-specific)
49+
- [Upgrading](#upgrading)
50+
- [Upgrading from version 2 to 3](#upgrading-from-version-2-to-3)
51+
- [Security contact information](#security-contact-information)
5252

5353
## Installation
5454

@@ -61,7 +61,7 @@ Make sure you have the MongoDB PHP driver installed. You can find installation i
6161
| 9.x | 3.9.x | :white_check_mark: |
6262
| 8.x | 3.8.x | :white_check_mark: |
6363
| 7.x | 3.7.x | :x: |
64-
| 6.x | 3.6.x | :white_check_mark: |
64+
| 6.x | 3.6.x | :x: |
6565
| 5.8.x | 3.5.x | :x: |
6666
| 5.7.x | 3.4.x | :x: |
6767
| 5.6.x | 3.4.x | :x: |
@@ -113,15 +113,17 @@ $capsule->getDatabaseManager()->extend('mongodb', function($config, $name) {
113113
});
114114
```
115115

116-
## Testing
116+
Testing
117+
-------
117118

118119
To run the test for this package, run:
119120

120121
```
121122
docker-compose up
122123
```
123124

124-
## Database Testing
125+
Database Testing
126+
-------
125127

126128
To reset the database after each test, add:
127129

@@ -140,7 +142,8 @@ Keep in mind that these traits are not yet supported:
140142
- `use Database Transactions;`
141143
- `use RefreshDatabase;`
142144

143-
## Configuration
145+
Configuration
146+
-------------
144147

145148
To configure a new MongoDB connection, add a new connection entry to `config/database.php`:
146149

@@ -172,7 +175,8 @@ Instead of using a connection string, you can also use the `host` and `port` con
172175

173176
The `options` key in the connection configuration corresponds to the [`uriOptions` parameter](https://www.php.net/manual/en/mongodb-driver-manager.construct.php#mongodb-driver-manager.construct-urioptions).
174177

175-
## Eloquent
178+
Eloquent
179+
--------
176180

177181
### Extending the base model
178182

@@ -770,7 +774,8 @@ DB::collection('users')
770774
$user->unset('note');
771775
```
772776

773-
## Relationships
777+
Relationships
778+
-------------
774779

775780
### Basic Usage
776781

@@ -816,7 +821,7 @@ class Item extends Model
816821

817822
### belongsToMany and pivots
818823

819-
The belongsToMany relation will not use a pivot "table" but will push id's to a **related_ids** attribute instead. This makes the second parameter for the belongsToMany method useless.
824+
The belongsToMany relation will not use a pivot "table" but will push id's to a __related_ids__ attribute instead. This makes the second parameter for the belongsToMany method useless.
820825

821826
If you want to define custom keys for your relation, set it to `null`:
822827

@@ -979,7 +984,8 @@ $newAuthor = new Author(['name' => 'Jane Doe']);
979984
$book->author()->save($newAuthor);
980985
```
981986

982-
## Query Builder
987+
Query Builder
988+
-------------
983989

984990
### Basic Usage
985991

@@ -1004,7 +1010,8 @@ If you are familiar with [Eloquent Queries](http://laravel.com/docs/queries), th
10041010

10051011
To see the available operations, check the [Eloquent](#eloquent) section.
10061012

1007-
## Transactions
1013+
Transactions
1014+
------------
10081015

10091016
Transactions require MongoDB version ^4.0 as well as deployment of replica set or sharded clusters. You can find more information [in the MongoDB docs](https://docs.mongodb.com/manual/core/transactions/)
10101017

@@ -1052,7 +1059,8 @@ DB::commit();
10521059
DB::rollBack();
10531060
```
10541061

1055-
## Schema
1062+
Schema
1063+
------
10561064

10571065
The database driver also has (limited) schema builder support. You can easily manipulate collections and set indexes.
10581066

@@ -1121,7 +1129,8 @@ Schema::create('bars', function ($collection) {
11211129
});
11221130
```
11231131

1124-
## Extending
1132+
Extending
1133+
---------
11251134

11261135
### Cross-Database Relationships
11271136

@@ -1225,7 +1234,8 @@ $app->make('queue');
12251234
$app->register(Jenssegers\Mongodb\MongodbQueueServiceProvider::class);
12261235
```
12271236

1228-
## Upgrading
1237+
Upgrading
1238+
---------
12291239

12301240
#### Upgrading from version 2 to 3
12311241

0 commit comments

Comments
 (0)
0