Skip to content

Commit f1b01c3

Browse files
committed
Update mentioning of pgsphere in the docs
1 parent b70a116 commit f1b01c3

2 files changed

Lines changed: 9 additions & 11 deletions

File tree

‎README.md‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,9 @@ to install the generated parser in your virtual environment.
6363
Additional requirements
6464
-----------------------
6565
The queryparser assumes that the PostgreSQL database has the extension
66-
[pg_sphere](https://github.com/kimakan/pgsphere/tree/aiprdbms16) installed.
67-
Although the `pg_sphere` is not required for the python module, the PostgreSQL
68-
**queries will not run** without this extension installed on the database.
66+
[pg_sphere](https://github.com/postgrespro/pgsphere) installed.
67+
Although `pg_sphere` is not required for the Python module, PostgreSQL
68+
**queries will not run** without this extension installed in the database.
6969

7070

7171
Parsing MySQL and PostgreSQL
@@ -120,7 +120,7 @@ the `ADQLQueryTranslator` class
120120

121121
```python
122122
from queryparser.adql import ADQLQueryTranslator
123-
adql = "SELECT TOP 100 POINT('ICRS', ra, de) FROM db.tab;"
123+
adql = "SELECT TOP 100 POINT('ICRS', ra, dec) FROM db.tab;"
124124
adt = ADQLQueryTranslator(adql)
125125
```
126126

@@ -130,7 +130,7 @@ and calling
130130
adt.to_postgresql()
131131
```
132132

133-
which returns a translated string representing a valid MySQL query if
133+
which returns a translated string representing a valid PostgreSQL query if
134134
the ADQL query had no errors. The PostgreSQL query can then be parsed with the
135135
`PostgreSQLQueryProcessor` in the same way as shown above.
136136

@@ -149,4 +149,3 @@ then run the test suite with
149149
```bash
150150
python -m pytest lib/
151151
```
152-

‎docs/development.md‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,7 @@ processed and can be used to check, for example, for permissions before the
99
query is sent to the server.
1010

1111
In addition, queryparser can also work with ADQL queries which can be translated
12-
to either MySQL or PostgreSQL language and then further processed the same
13-
way.
12+
to PostgreSQL and then further processed the same way.
1413

1514
Below is a more detailed description along with instructions for anyone who is
1615
interested in further developing the package.
@@ -49,14 +48,14 @@ Individual dialect functionality (MySQL in this case) with increased verbosity
4948
can be tested with
5049

5150
```bash
52-
pytest /lib/queryparser/testing/test_mysql.py -v
51+
pytest lib/queryparser/testing/test_mysql.py -v
5352
```
5453

5554
Individual tests (20th MySQL test in this case, but otherwise any test
5655
that includes the string 't20') are ran with
5756

5857
```bash
59-
pytest /lib/queryparser/testing/test_mysql.py -k t20
58+
pytest lib/queryparser/testing/test_mysql.py -k t20
6059
```
6160

6261
If the package `pytest-cov` is installed then the detailed coverage report
@@ -120,7 +119,7 @@ and an ADQL translator. The processors accept any SELECT-like query and
120119
after the process_query() method has been executed, several elements of
121120
the query are extracted (all touch columns and tables, used keywords and functions).
122121
Before the processing the query is validated and invalid queries are rejected.
123-
The ADQL translator allows translating valid ADQL queries to MySQL or PostgreSQL.
122+
The ADQL translator allows translating valid ADQL queries to PostgreSQL.
124123

125124
Most of the processor code is shared between MySQL and PostgreSQL and is
126125
therefore merged together inside of the `common.py`. This file consists

0 commit comments

Comments
 (0)