Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
jeevanchalke committed Jul 4, 2024
1 parent 11921b3 commit 5396a8b
Showing 1 changed file with 20 additions and 46 deletions.
66 changes: 20 additions & 46 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ This PostgreSQL extension implements a Foreign Data Wrapper (FDW) for
Please note that this version of mongo_fdw works with PostgreSQL and EDB
Postgres Advanced Server 12, 13, 14, 15, 16 and 17.

<img src="https://upload.wikimedia.org/wikipedia/commons/2/29/Postgresql_elephant.svg" align="center" height="100" alt="PostgreSQL"/> + <img src="https://www.tutorialsteacher.com/Content/images/home/mongodb.svg" align="center" height="100" alt="MongoDB"/>

Contents
--------

Expand All @@ -17,13 +15,14 @@ Contents
3. [Installation](#installation)
4. [Usage](#usage)
5. [Functions](#functions)
6. [Identifier case handling](#identifier-case-handling)
7. [Generated columns](#generated-columns)
8. [Character set handling](#character-set-handling)
9. [Examples](#examples)
10. [Limitations](#limitations)
11. [Contributing](#contributing)
12. [Useful links](#useful-links)
6. [Character set handling](#character-set-handling)
7. [Examples](#examples)
8. [Limitations](#limitations)
9. [Contributing](#contributing)
10. [Support](#support)
11. [Useful links](#useful-links)
12. [License](#license)


Features
--------
Expand Down Expand Up @@ -251,42 +250,16 @@ Functions
As well as the standard `mongo_fdw_handler()` and `mongo_fdw_validator()`
functions, `mongo_fdw` provides the following user-callable utility functions:

**Yet not described!**.

Identifier case handling
------------------------

PostgreSQL folds identifiers to lower case by default, MongoDB use JSON notation of identifiers.

All transformation rules and problems **yet not described**.

Generated columns
-----------------

`mongo_fdw` doesn't provides support for PostgreSQL's generated
columns (PostgreSQL 12+).

**Behaviour with generated columns yet not tested and not described**.
- **mongo_fdw_version()**

Note that while `mongo_fdw` will `INSERT` or `UPDATE` the generated column value
in MongoDB, there is nothing to stop the value being modified within MongoDB,
and hence no guarantee that in subsequent `SELECT` operations the column will
still contain the expected generated value. This limitation also applies to
`postgres_fdw`.

For more details on generated columns see:

- [Generated Columns](https://www.postgresql.org/docs/current/ddl-generated-columns.html)
- [CREATE FOREIGN TABLE](https://www.postgresql.org/docs/current/sql-createforeigntable.html)
Returns the version number as an integer.

Character set handling
----------------------

`BSON` in MongoDB can only be encoded in `UTF-8`. Also `UTF-8` is recommended and
de-facto most popular PostgreSQL server encoding.

Encodings mapping between PostgreSQL and MongoDB **yet not described**.

Examples
--------

Expand Down Expand Up @@ -462,6 +435,16 @@ Contributing
Have a fix for a bug or an idea for a great new feature? Great! Check
out the contribution guidelines [here][3].

Support
-------
This project will be modified to maintain compatibility with new
PostgreSQL and EDB Postgres Advanced Server releases.

If you need commercial support, please contact the EnterpriseDB sales
team, or check whether your existing PostgreSQL support provider can
also support `mongo_fdw`.


Useful links
------------

Expand All @@ -488,15 +471,6 @@ Reference FDW realization, `postgres_fdw`
- https://wiki.postgresql.org/wiki/Fdw
- https://pgxn.org/tag/fdw/

Support
-------
This project will be modified to maintain compatibility with new
PostgreSQL and EDB Postgres Advanced Server releases.

If you need commercial support, please contact the EnterpriseDB sales
team, or check whether your existing PostgreSQL support provider can
also support `mongo_fdw`.


License
-------
Expand Down

0 comments on commit 5396a8b

Please sign in to comment.