Skip to content

Commit 1b0d060

Browse files
committed
Add docs note about authenticated queries
1 parent 067c6d2 commit 1b0d060

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

docs/eso/eso.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,27 @@ interaction with the ESO archive.
103103
INFO: Downloading file 1/1 https://dataportal.eso.org/dataPortal/file/ADP.2023-03-02T01:01:24.355
104104
ERROR: Access denied to https://dataportal.eso.org/dataPortal/file/ADP.2023-03-02T01:01:24.355
105105

106+
.. note::
107+
Even after logging with `Eso.login()`, TAP queries are not authenticated by default. To issue
108+
authenticated queries, the keyword argument `authenticated` must be set to `True` explicitly in
109+
the query functions. For example:
110+
111+
.. doctest-skip::
112+
113+
eso = Eso()
114+
eso.ROW_LIMIT = None
115+
eso.login(username="ICONDOR")
116+
117+
# Some files are missing without `authenticated=True`
118+
files_tbl = eso.query_instrument("nirps")
119+
120+
# Get all files to which the authenticated user has access
121+
files_tbl = eso.query_instrument("nirps", authenticated=True)
122+
123+
Review your queries carefully and update them accordingly to ensure you are retrieving
124+
all your expected results. If you don't stricly need to run an authenticated query, use
125+
the default `authenticated=False`, since it will retrieve your results much faster.
126+
106127
Automatic password
107128
------------------
108129

0 commit comments

Comments
 (0)