Skip to content

Commit 9efdf4c

Browse files
cbushcbush
authored
DOCSP-5406 Update Perl landing page (#505)
1 parent b935a24 commit 9efdf4c

File tree

4 files changed

+111
-241
lines changed

4 files changed

+111
-241
lines changed

‎source/drivers/driver-compatibility-reference.txt

Lines changed: 2 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -171,75 +171,14 @@ MongoDB Compatibility
171171

172172
.. include:: /includes/extracts/perl-driver-compatibility-matrix-mongodb.rst
173173

174-
.. list-table::
175-
:header-rows: 1
176-
:stub-columns: 1
177-
:class: compatibility-large
178-
179-
* - Perl Driver
180-
- MongoDB 4.0
181-
- MongoDB 3.6
182-
- MongoDB 3.4
183-
- MongoDB 3.2
184-
- MongoDB 3.0
185-
- MongoDB 2.6
186-
187-
* - 2.0.x
188-
- |checkmark|
189-
- |checkmark|
190-
- |checkmark|
191-
- |checkmark|
192-
- |checkmark|
193-
- |checkmark|
194-
195-
* - 1.8.x
196-
-
197-
-
198-
- |checkmark|
199-
- |checkmark|
200-
- |checkmark|
201-
- |checkmark|
202-
203-
* - 1.6.x
204-
-
205-
-
206-
- |checkmark|
207-
- |checkmark|
208-
- |checkmark|
209-
- |checkmark|
210-
211-
* - 1.4.x
212-
-
213-
-
214-
-
215-
- |checkmark|
216-
- |checkmark|
217-
- |checkmark|
218-
219-
* - 1.2.x
220-
-
221-
-
222-
-
223-
- |checkmark|
224-
- |checkmark|
225-
- |checkmark|
226-
227-
* - 1.0.x
228-
-
229-
-
230-
-
231-
-
232-
- |checkmark|
233-
- |checkmark|
234-
235-
.. include:: /includes/older-server-versions-unsupported.rst
174+
.. include:: /includes/mongodb-compatibility-table-perl.rst
236175

237176
.. _reference-compatibility-language-perl:
238177

239178
Language Compatibility
240179
~~~~~~~~~~~~~~~~~~~~~~
241180

242-
The MongoDB Perl driver requires Perl 5.10.1 or later.
181+
.. include:: /includes/language-compatibility-table-perl.rst
243182

244183
.. _reference-compatibility-php:
245184

‎source/drivers/perl.txt

Lines changed: 44 additions & 178 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
.. _perl-language-center:
22

3+
.. include:: /includes/unicode-checkmark.rst
4+
35
===================
46
MongoDB Perl Driver
57
===================
@@ -12,215 +14,79 @@ MongoDB Perl Driver
1214
:depth: 1
1315
:class: twocols
1416

15-
The official Perl driver is available through CPAN as the package
16-
`MongoDB <https://metacpan.org/release/MongoDB>`_.
17-
18-
* `Installation
19-
<https://github.com/mongodb/mongo-perl-driver/blob/master/INSTALL.md>`_
20-
* `Tutorial
21-
<https://metacpan.org/pod/distribution/MongoDB/lib/MongoDB/Tutorial.pod>`_
22-
23-
MongoDB Perl Driver Compatibility
24-
---------------------------------
25-
26-
MongoDB Compatibility
27-
~~~~~~~~~~~~~~~~~~~~~
28-
29-
.. include:: /includes/extracts/perl-driver-compatibility-matrix-mongodb.rst
30-
31-
32-
.. list-table::
33-
:header-rows: 1
34-
:stub-columns: 1
35-
:class: compatibility-large
36-
37-
* - Perl Driver
38-
- MongoDB 4.0
39-
- MongoDB 3.6
40-
- MongoDB 3.4
41-
- MongoDB 3.2
42-
- MongoDB 3.0
43-
- MongoDB 2.6
44-
- MongoDB 2.4
45-
46-
* - 2.0.x
47-
- |checkmark|
48-
- |checkmark|
49-
- |checkmark|
50-
- |checkmark|
51-
- |checkmark|
52-
- |checkmark|
53-
- |checkmark|
54-
55-
* - 1.8.x
56-
-
57-
-
58-
- |checkmark|
59-
- |checkmark|
60-
- |checkmark|
61-
- |checkmark|
62-
- |checkmark|
63-
64-
65-
* - 1.6.x
66-
-
67-
-
68-
- |checkmark|
69-
- |checkmark|
70-
- |checkmark|
71-
- |checkmark|
72-
- |checkmark|
73-
74-
* - 1.4.x
75-
-
76-
-
77-
-
78-
- |checkmark|
79-
- |checkmark|
80-
- |checkmark|
81-
- |checkmark|
82-
83-
* - 1.2.x
84-
-
85-
-
86-
-
87-
- |checkmark|
88-
- |checkmark|
89-
- |checkmark|
90-
- |checkmark|
91-
92-
* - 1.0.x
93-
-
94-
-
95-
-
96-
-
97-
- |checkmark|
98-
- |checkmark|
99-
- |checkmark|
100-
101-
.. include:: /includes/older-server-versions-unsupported.rst
102-
103-
Language Compatibility
104-
~~~~~~~~~~~~~~~~~~~~~~
105-
106-
The MongoDB Perl driver requires Perl 5.10.1 or later.
17+
Introduction
18+
------------
10719

108-
.. include:: /includes/unicode-checkmark.rst
20+
This is the official MongoDB Perl Driver.
10921

110-
Third-party Perl Drivers
111-
------------------------
22+
- `Tutorial <https://metacpan.org/pod/distribution/MongoDB/lib/MongoDB/Tutorial.pod>`__
11223

113-
Mango
114-
~~~~~
24+
- `Examples <https://metacpan.org/pod/distribution/MongoDB/lib/MongoDB/Examples.pod>`__
11525

116-
`Mango <https://metacpan.org/module/Mango>`_ is a pure-Perl, non-blocking,
117-
asynchronous driver for MongoDB, designed to work with the Mojolicious web framework.
118-
Created by Sebastian Riedel.
26+
- `API Reference <https://metacpan.org/release/MongoDB>`_
11927

120-
Object-Document Mappers
121-
-----------------------
28+
- `Changelog <https://metacpan.org/changes/distribution/MongoDB>`__
12229

123-
Meerkat
124-
~~~~~~~
30+
- `Source Code <https://github.com/mongodb/mongo-perl-driver>`__
12531

126-
`Meerkat <https://metacpan.org/module/Meerkat>`_ lets you manage MongoDB documents
127-
as Moose objects. Your objects represent projections of the document state maintained in the database.
128-
Meerkat is designed for atomic operations that keep client-side objects in sync with
129-
the database. Created by David Golden.
13032

131-
MongoDB::Simple
132-
~~~~~~~~~~~~~~~
33+
Installation
34+
------------
13335

134-
`MongoDB::Simple <https://metacpan.org/module/MongoDB::Simple>`_ is
135-
a basic object-to-document mapping system with few dependencies. Created
136-
by Ian Kent.
36+
The Perl Driver is available through CPAN as the package
37+
`MongoDB <https://metacpan.org/release/MongoDB>`_.
13738

138-
Mongoose
139-
~~~~~~~~
39+
You can install the latest stable release by installing the MongoDB package:
14040

141-
`Mongoose <https://metacpan.org/module/Mongoose>`_ is an attempt to
142-
bring together the full power of Moose with MongoDB. It provides a full suite
143-
of object-to-document mapping facilities. Created by Rodrigo
144-
de Oliveira Gonzalez.
41+
.. code-block:: sh
14542

146-
MongoDBI
147-
~~~~~~~~
43+
$ cpan MongoDB
14844

149-
`MongoDBI <https://metacpan.org/module/MongoDBI>`_ is an
150-
Object-Document-Mapper (ODM) for MongoDB. It allows you to create
151-
Moose-based classes to interact with MongoDB databases.
45+
See `Installation <https://github.com/mongodb/mongo-perl-driver/blob/master/INSTALL.md>`_
46+
for more information.
15247

153-
MongoDBI allows you to easily model classes while leveraging
154-
the power of MongoDB's schema-less and expeditious document-based design,
155-
dynamic queries, and atomic modifier operations. Created by Al Newkirk.
15648

157-
MongoDBx::Class
158-
~~~~~~~~~~~~~~~
49+
Connect to MongoDB Atlas
50+
------------------------
15951

160-
`MongoDBx::Class <https://metacpan.org/module/MongoDBx::Class>`_ is an
161-
ORM for MongoDB databases. MongoDBx::Class takes advantage of the fact
162-
that Perl's MongoDB driver is Moose-based to extend and tweak the
163-
driver's behavior, instead of wrapping it. This means MongoDBx::Class
164-
does not define its own syntax, so you simply use it exactly as you
165-
would the MongoDB driver directly. Created by Ido Perlmuter.
52+
To connect to a `MongoDB Atlas <https://docs.atlas.mongodb.com/>`_ cluster, use the `Atlas connection string <https://docs.atlas.mongodb.com/driver-connection>`__ for your cluster:
16653

167-
Other Perl Tools
168-
----------------
54+
.. code-block:: perl
16955

170-
BSON and BSON::XS
171-
~~~~~~~~~~~~~~~~~
56+
use MongoDB;
17257

173-
`BSON <https://metacpan.org/module/BSON>`_ is a pure-Perl BSON
174-
implementation. Created by Stefan G. and maintained by MongoDB.
58+
my $client = MongoDB->connect(
59+
"mongodb+srv://<username>:<password>@<cluster-address>/test?retryWrites=true&w=majority"
60+
);
61+
my $db = $client->get_database( 'test' );
17562

176-
`BSON::XS <https://metacpan.org/module/BSON::XS>`_ is an optional,
177-
XS-optimized BSON implementation plugin for the BSON module. Created
178-
by MongoDB.
17963

180-
Entities::Backend::MongoDB
181-
~~~~~~~~~~~~~~~~~~~~~~~~~~
64+
See `Connecting <https://metacpan.org/pod/distribution/MongoDB/lib/MongoDB/Tutorial.pod#CONNECTING>`__
65+
for more information.
18266

183-
`Entities::Backend::MongoDB <https://metacpan.org/module/Entities::Backend::MongoDB>`_
184-
is a backend for the Entities user management and authorization system. It
185-
stores all entities and relations between them in a MongoDB database. Created by
186-
Ido Perlmuter.
18767

188-
MojoX::Session::Store::MongoDB
189-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
68+
Compatibility
69+
-------------
19070

191-
`MojoX::Session::Store::MongoDB <https://metacpan.org/module/MojoX::Session::Store::MongoDB>`_
192-
is a store for `MojoX::Session <https://metacpan.org/module/MojoX::Session>`_
193-
that stores a session in a MongoDB database. Created by Ask Bjørn Hansen.
71+
MongoDB Compatibility
72+
~~~~~~~~~~~~~~~~~~~~~
19473

195-
MongoDB::Admin
196-
~~~~~~~~~~~~~~
74+
.. include:: /includes/mongodb-compatibility-table-perl.rst
19775

198-
`MongoDB::Admin <https://metacpan.org/module/MongoDB::Admin>`_ is a
199-
collection of MongoDB administrative functions. Created by David Burley.
76+
Language Compatibility
77+
~~~~~~~~~~~~~~~~~~~~~~
20078

201-
MongoDBx::Queue
202-
~~~~~~~~~~~~~~~
79+
.. include:: /includes/language-compatibility-table-perl.rst
20380

204-
`MongoDBx::Queue <https://metacpan.org/module/MongoDBx::Queue>`_ is
205-
a basic message queue system backed by MongoDB. Created by David Golden.
20681

207-
MongoX
208-
~~~~~~
82+
How to get help
83+
---------------
20984

210-
`MongoX <https://metacpan.org/module/MongoX>`_ is light wrapper for
211-
MongoDB, providing some nice DSL sugar. Created by Pan Fan.
85+
- Join our `Google Group <https://groups.google.com/forum/#!forum/mongodb-user>`__.
86+
- Ask on `Stack Overflow <https://stackoverflow.com/questions/tagged/mongodb+perl>`__.
87+
- Visit our `Support Channels <https://docs.mongodb.com/manual/support/>`__.
88+
- See our `JIRA <https://jira.mongodb.org/projects/PERL/summary>`__ to raise issues or submit feature requests.
21289

213-
MooseX::Role::MongoDB
214-
~~~~~~~~~~~~~~~~~~~~~
21590

216-
`MooseX::Role::MongoDB <https://metacpan.org/module/MooseX::Role::MongoDB>`_
217-
is a Moose role which provides connection management and automatic
218-
fork handling for the MongoDB driver. Created by David Golden.
21991

220-
OOP Perl CMS
221-
~~~~~~~~~~~~
22292

223-
`OOP Perl CMS <http://www.waitman.net/mod_perl-mongodb-CMS.html>`_ is
224-
based on Khurt Williams' Object Oriented Perl methodology and can be
225-
used as a basic CMS framework or as a basis for your own CMS system. It
226-
uses Apache & mod_perl with MongoDB backend. Created by Waitman Gobble.

‎source/includes/language-compatibility-table-perl.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
The MongoDB Perl driver requires Perl 5.10.1 or later.

0 commit comments

Comments
 (0)