generated from tpl/purs
Compare commits
74 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
65c3a3c902
|
||
|
|
2d1f2e4695
|
||
|
f16a348414
|
|||
|
f35576e4e6
|
|||
|
4ede0247d6
|
|||
|
5f8be2e1f2
|
|||
|
4179367385
|
|||
|
f0fa32ab9c
|
|||
|
0b1680a967
|
|||
|
d2c3eba082
|
|||
|
f7b2e6ceae
|
|||
|
23496f71f3
|
|||
|
2e7015b19d
|
|||
|
3c686415b0
|
|||
|
4308ebe7e1
|
|||
|
dbc2e70bf2
|
|||
|
901e931af4
|
|||
|
d5cc8ad95e
|
|||
|
1a96e2e6d8
|
|||
|
8350bc1c4a
|
|||
|
fad3e8dbcb
|
|||
|
275bbe3583
|
|||
|
1d3c16a3a5
|
|||
|
a45aaf5647
|
|||
|
223eeb9160
|
|||
|
7044099d54
|
|||
|
814b1ad590
|
|||
|
bce45daa27
|
|||
|
8a6f84e8bf
|
|||
|
cd01d280f4
|
|||
|
341971d3f3
|
|||
|
8c77779406
|
|||
|
11c1645173
|
|||
|
c9e5ee9205
|
|||
|
9ab6e37bb1
|
|||
|
f23eb4143a
|
|||
|
d10d21b708
|
|||
|
826c1e10b1
|
|||
|
fbb1f3b8a5
|
|||
|
b4a84a3210
|
|||
|
a56add0ffc
|
|||
|
7ed85ae22b
|
|||
|
bead3d81c3
|
|||
|
27a7abb329
|
|||
|
86263a7521
|
|||
|
2db29b8916
|
|||
|
cfb01608cd
|
|||
|
aca76f7de3
|
|||
|
188403681a
|
|||
|
ca7ebb4337
|
|||
|
b3806d5f6e
|
|||
|
adb414662e
|
|||
|
69721fcda4
|
|||
|
a616440abe
|
|||
|
d66c3261b6
|
|||
|
4e2fd8fa3f
|
|||
|
e59266406b
|
|||
|
3be968da3a
|
|||
|
20a0a6de31
|
|||
|
036a7b5de9
|
|||
|
639bee96d0
|
|||
|
24b2156524
|
|||
|
3e9f22397d
|
|||
|
d3be053a8b
|
|||
|
1319a4bce7
|
|||
|
8722e69013
|
|||
|
5dc5912933
|
|||
|
a4d4e6bd75
|
|||
|
f0d2d764fe
|
|||
|
ea3ff9b003
|
|||
|
4832b594dc
|
|||
|
aad6544658
|
|||
|
89dec85a31
|
|||
|
5a99e58062
|
674
LICENSE
Normal file
674
LICENSE
Normal file
@@ -0,0 +1,674 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
218
README.md
218
README.md
@@ -5,10 +5,10 @@ Purescript PostgreSQL driver
|
||||
## Table of Contents
|
||||
- [Getting Started](#getting-started)
|
||||
- [Data](#data)
|
||||
- [Rows](#data---rows)
|
||||
- [Ranges](#data---ranges)
|
||||
- [Queries](#queries)
|
||||
- [Builder](#queries---builder)
|
||||
- [Errors](#errors)
|
||||
- [Monads](#monads)
|
||||
- [`PostgresT`](#monads---postgrest)
|
||||
- [`SessionT`](#monads---sessiont)
|
||||
@@ -51,11 +51,12 @@ import Effect.Class (liftEffect)
|
||||
import Effect.Aff (launchAff_)
|
||||
import Effect.Console (log)
|
||||
import Control.Monad.Postgres (runPostgres, query)
|
||||
import Effect.Postgres.Error.Except as PG.X
|
||||
|
||||
main :: Effect Unit
|
||||
main =
|
||||
launchAff_ do
|
||||
msg <- runPostgres pgConfig $ query "select 'hello, world!'"
|
||||
msg <- PG.X.run $ runPostgres pgConfig $ query "select 'hello, world!'"
|
||||
liftEffect $ log msg -- logs 'hello, world!'
|
||||
```
|
||||
|
||||
@@ -79,43 +80,54 @@ class MonadSession m where
|
||||
```
|
||||
|
||||
## Data
|
||||
Single SQL values are serialized to and deserialized from JS via [`pg-types`]
|
||||
(with some [tweaks][`modifyPgTypes`]).
|
||||
Scalar values are serialized & deserialized using the `Serialize` / `Deserialize` typeclasses.
|
||||
Implemented for `Int`, `String`, `DateTime`, `Buffer`, `BigInt`, `Boolean`, `Number`, `Array`, [`Range`]s, `Maybe`, [`Null`] and `Unit`.
|
||||
|
||||
The conversion between [`Raw`] JS values and purescript values is done
|
||||
with the [`Serialize`] and [`Deserialize`] typeclasses.
|
||||
There aren't any typeclass instances for unmarshalling rows by design. The rationale: as apps grow we often need to ask more of a relational database than just CRUD operations. Queries tend to be somewhat living, with joins and columns being added and removed, so it should be easy to modify queries and reflect the change in the purescript type they're unmarshalled into.
|
||||
|
||||
The [`Rep`] class indicates a type is [`Rep`]resentable as a SQL value.
|
||||
[`Rep`] is automatically implemented for all types that are [`Serialize`]
|
||||
and [`Deserialize`].
|
||||
The lib does this by transforming the js row array `Array<Array<unknown>>` with `FromRows` ("how many rows do you expect?"), then each row with `FromRow`, then each value with `Deserialize`.
|
||||
|
||||
Implementations are provided for `Int`, `String`, `DateTime`, `Buffer`,
|
||||
`BigInt`, `Boolean`, `Number`, `Array`, [`Range`]s, `Maybe`, [`Null`]
|
||||
and `Unit`.
|
||||
|
||||
### Data - Rows
|
||||
A single row (multiple SQL values) are deserialized using [`FromRow`],
|
||||
which is implemented for:
|
||||
- n-tuples of [`Rep`] types
|
||||
- `Array a` where `a` is [`Rep`]
|
||||
- A single [`Rep`] type
|
||||
|
||||
Examples:
|
||||
Starting with querying directly into the loose rows as `Array (Array Raw)`:
|
||||
```purescript
|
||||
(fromRow [] :: Maybe Int) == Nothing
|
||||
(fromRow [1] :: Maybe Int) == Just 1
|
||||
(fromRow [1, 2] :: Maybe Int) == Just 1
|
||||
(fromRow [] :: Int /\ Int) == Error
|
||||
(fromRow [1, 2] :: Int /\ Int) == 1 /\ 2
|
||||
(fromRow [] :: Array Int) == []
|
||||
(fromRow [1, 2] :: Array Int) == [1, 2]
|
||||
a :: Array (Array Raw) <- query "select a, b, c from (values (1, 'foo', true), (4, 'bar', false)) as foo(a, b, c)"
|
||||
liftEffect $ log $ show a -- [[1, "foo", true], [4, "bar", false]]
|
||||
```
|
||||
|
||||
Multiple rows are deserialized using [`FromRows`],
|
||||
which is implemented for:
|
||||
- `Array a` where `a` is [`FromRow`]
|
||||
- `Maybe a` where `a` is [`FromRow`] (equivalent to `Array.head <<< fromRows`)
|
||||
- `a` where `a` is [`FromRow`] (throws if 0 rows yielded)
|
||||
We can tell the query to deserialize the rows as `Int /\ String /\ Boolean` (postgres shape of `(int, text, boolean)` ):
|
||||
```purescript
|
||||
a :: Array (Int /\ String /\ Boolean) <- query "select a, b, c from (values (1, 'foo', true), (4, 'bar', false)) as foo(a, b, c)"
|
||||
liftEffect $ log $ show a -- [Tuple 1 (Tuple "foo" true), Tuple 1 (Tuple "foo" true)]
|
||||
```
|
||||
|
||||
From there we could unmarshal to `Maybe` to get 0 or 1, or directly into the row type if expect at least 1 row:
|
||||
```purescript
|
||||
a :: Maybe (Int /\ String /\ Boolean) <- query "select a, b, c from (values (1, 'foo', true), (4, 'bar', false)) as foo(a, b, c)"
|
||||
liftEffect $ log $ show a -- Just (Tuple 1 (Tuple "foo" true))
|
||||
|
||||
b :: Int /\ String /\ Boolean <- query "select 1, 'foo', true"
|
||||
liftEffect $ log $ show b -- Tuple 1 (Tuple "foo" true)
|
||||
|
||||
c :: Maybe (Int /\ String /\ Boolean) <- query "select null, null, null limit 0"
|
||||
liftEffect $ log $ show c -- Nothing
|
||||
```
|
||||
|
||||
`FromRows row` supports `Array row`, `Maybe row` or just `row` (failing if 0 returned).
|
||||
|
||||
`FromRow row` supports `Array a`, `Tuple a b`, `Maybe a`, or `a` (where `a` / `b` are `Deserialize`)
|
||||
|
||||
The idea is that you can deserialize query results directly to the purescript type you care about:
|
||||
- `a :: Int <- query "select 1"`
|
||||
- because there's no outer `Array`, we're saying this just returns 1 row. because there's no inner `Array`, we're saying the row just has 1 value; the int!
|
||||
- `a :: Array Int <- query "select foo.a from (values (1), (2), (3)) as foo(a)"`
|
||||
- Now there's an outer `Array`, so we expect the query to yield multiple rows of shape `(int)`
|
||||
- `a :: Array (Maybe Int) <- query "select foo.a from (values (1), (null), (3)) as foo(a)"`
|
||||
- Some of them are `NULL`!
|
||||
- `a :: Int /\ Int <- query "select 1, 2"`
|
||||
- 1 row of `(int, int)`
|
||||
- `a :: Array (Int /\ String) <- query "select id, email from users"`
|
||||
- Multiple rows of `(int, string)`
|
||||
- `a :: Maybe (String /\ String /\ String) <- query $ "select first_name, last_name, email from users where id = $1" /\ userId`
|
||||
- 0 or 1 rows of `(text, text, text)`
|
||||
|
||||
### Data - Ranges
|
||||
Postgres ranges are represented with [`Range`].
|
||||
@@ -181,21 +193,37 @@ that will reference that value in the query.
|
||||
|
||||
[`Query.Builder.build`] renders the query to [`Query`]
|
||||
|
||||
## Errors
|
||||
Errors are wrapped in [`Error`]:
|
||||
```haskell
|
||||
data Error
|
||||
= Deserializing Query Foreign.MultipleErrors
|
||||
| Serializing Foreign.MultipleErrors
|
||||
| Executing Query Effect.Error
|
||||
| Connecting Effect.Error
|
||||
| Disconnecting Effect.Error
|
||||
| Other Effect.Error
|
||||
```
|
||||
|
||||
Most operations in this library return a [`Except`], which is just
|
||||
`ExceptT` pinned to `NonEmptyArray Error`.
|
||||
|
||||
This can be unlifted to `Aff` with [`Except.run`].
|
||||
|
||||
## Monads
|
||||
### Monads - `PostgresT`
|
||||
[`PostgresT`] is the database driver's main entry point,
|
||||
and is just an `Aff` with access to a [`Pool`].
|
||||
[`PostgresT`] is a monadic context with a connection [`Pool`]. It allows running [`transaction`]s, simple [queries][`query`] and more.
|
||||
|
||||
Run in `Aff` with [`runPostgres`]:
|
||||
#### Running in Aff
|
||||
```purescript
|
||||
main :: Effect Unit
|
||||
main =
|
||||
launchAff_ do
|
||||
hi <- runPostgres {} $ query "select 'hi!'"
|
||||
hi <- PG.X.run $ runPostgres {} $ query "select 'hi!'"
|
||||
liftEffect $ log hi
|
||||
```
|
||||
|
||||
Execute [`SessionT`] monads with [`session`] or [`transaction`]:
|
||||
#### Executing a transaction
|
||||
```purescript
|
||||
dbMain :: PostgresT Aff Unit
|
||||
dbMain = do
|
||||
@@ -210,7 +238,7 @@ dbMain = do
|
||||
pure unit
|
||||
```
|
||||
|
||||
Implements [`MonadSession`] as a shorthand for single-query [`session`]s:
|
||||
#### Simple queries
|
||||
```purescript
|
||||
dbMain :: PostgresT Aff Int
|
||||
dbMain = exec_ $ "insert into persons (name) values ($1);" /\ "Sarah"
|
||||
@@ -218,23 +246,25 @@ dbMain = exec_ $ "insert into persons (name) values ($1);" /\ "Sarah"
|
||||
-- dbMain = session $ exec_ ...
|
||||
```
|
||||
|
||||
Execute [`CursorT`] monads with [`cursor`]:
|
||||
#### Executing cursor queries
|
||||
```purescript
|
||||
dbMain :: PostgresT Aff Int
|
||||
dbMain =
|
||||
cursor @(Int /\ String) "people_cursor" "select id, name from persons" do
|
||||
fetchOne -- Just (1 /\ "Henry")
|
||||
fetchAll -- [2 /\ "Sarah"]
|
||||
fetchOne -- Nothing
|
||||
a <- fetchOne -- Just (1 /\ "Henry")
|
||||
b <- fetchOne -- Just (2 /\ "Sarah")
|
||||
void $ move (MoveRelative -2)
|
||||
c <- fetchAll -- [1 /\ "Henry", 2 /\ "Sarah"]
|
||||
d <- fetchOne -- Nothing
|
||||
```
|
||||
|
||||
### Monads - `SessionT`
|
||||
[`SessionT`] is an `Aff` with access to a [`Client`]
|
||||
issued by a [`Pool`], connected to the database.
|
||||
[`SessionT`] is a context that can run queries using a specific [`Client`].
|
||||
|
||||
Run in [`PostgresT`] with [`session`] or [`transaction`]
|
||||
Sessions can be started in [`PostgresT`], which will ask the [`Pool`] for a [`Client`],
|
||||
then release the [`Client`] after the session completes.
|
||||
|
||||
Perform queries with [`query`], [`exec`] or [`exec_`]
|
||||
Within sessions, queries can be performed with [`query`], [`exec`] and [`exec_`].
|
||||
|
||||
### Monads - `CursorT`
|
||||
[`CursorT`] is a transaction [`SessionT`] with access to a named server-side cursor.
|
||||
@@ -255,59 +285,63 @@ the api of [`node-postgres`]:
|
||||
- release clients with [`Pool.release`] or [`Pool.destroy`]
|
||||
- release with [`Pool.end`]
|
||||
|
||||
[`Pool`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Effect.Aff.Postgres.Pool#t:Pool
|
||||
[`Config`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Effect.Aff.Postgres.Pool#t:Config
|
||||
[`Pool.make`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Effect.Aff.Postgres.Pool#v:make
|
||||
[`Pool.end`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Effect.Aff.Postgres.Pool#v:end
|
||||
[`Pool.connect`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Effect.Aff.Postgres.Pool#v:connect
|
||||
[`Pool.destroy`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Effect.Aff.Postgres.Pool#v:destroy
|
||||
[`Pool.release`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Effect.Aff.Postgres.Pool#v:release
|
||||
[`Pool`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Effect.Aff.Postgres.Pool#t:Pool
|
||||
[`Config`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Effect.Aff.Postgres.Pool#t:Config
|
||||
[`Pool.make`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Effect.Aff.Postgres.Pool#v:make
|
||||
[`Pool.end`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Effect.Aff.Postgres.Pool#v:end
|
||||
[`Pool.connect`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Effect.Aff.Postgres.Pool#v:connect
|
||||
[`Pool.destroy`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Effect.Aff.Postgres.Pool#v:destroy
|
||||
[`Pool.release`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Effect.Aff.Postgres.Pool#v:release
|
||||
|
||||
[`Client`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Effect.Aff.Postgres.Client#t:Client
|
||||
[`Client.end`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Effect.Aff.Postgres.Client#v:end
|
||||
[`Client.make`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Effect.Aff.Postgres.Client#v:make
|
||||
[`Client.connected`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Effect.Aff.Postgres.Client#v:connected
|
||||
[`Client.query`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Effect.Aff.Postgres.Client#v:query
|
||||
[`Client.queryRaw`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Effect.Aff.Postgres.Client#v:queryRaw
|
||||
[`Client.exec`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Effect.Aff.Postgres.Client#v:exec
|
||||
[`Client`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Effect.Aff.Postgres.Client#t:Client
|
||||
[`Client.end`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Effect.Aff.Postgres.Client#v:end
|
||||
[`Client.make`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Effect.Aff.Postgres.Client#v:make
|
||||
[`Client.connected`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Effect.Aff.Postgres.Client#v:connected
|
||||
[`Client.query`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Effect.Aff.Postgres.Client#v:query
|
||||
[`Client.queryRaw`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Effect.Aff.Postgres.Client#v:queryRaw
|
||||
[`Client.exec`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Effect.Aff.Postgres.Client#v:exec
|
||||
|
||||
[`Range`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Data.Postgres.Range#t:Range
|
||||
[`Range.gt`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Data.Postgres.Range#v:gt
|
||||
[`Range.gte`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Data.Postgres.Range#v:gte
|
||||
[`Range.lt`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Data.Postgres.Range#v:lt
|
||||
[`Range.lte`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Data.Postgres.Range#v:lte
|
||||
[`Range`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Data.Postgres.Range#t:Range
|
||||
[`Range.gt`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Data.Postgres.Range#v:gt
|
||||
[`Range.gte`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Data.Postgres.Range#v:gte
|
||||
[`Range.lt`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Data.Postgres.Range#v:lt
|
||||
[`Range.lte`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Data.Postgres.Range#v:lte
|
||||
|
||||
[`Raw`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Data.Postgres.Raw#t:Raw
|
||||
[`Null`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Data.Postgres.Raw#t:Null
|
||||
[`Raw`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Data.Postgres.Raw#t:Raw
|
||||
[`Null`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Data.Postgres.Raw#t:Null
|
||||
|
||||
[`Serialize`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Data.Postgres#t:Serialize
|
||||
[`Deserialize`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Data.Postgres#t:Deserialize
|
||||
[`Rep`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Data.Postgres#t:Rep
|
||||
[`modifyPgTypes`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Data.Postgres#v:modifyPgTypes
|
||||
[`Serialize`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Data.Postgres#t:Serialize
|
||||
[`Deserialize`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Data.Postgres#t:Deserialize
|
||||
[`Rep`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Data.Postgres#t:Rep
|
||||
[`modifyPgTypes`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Data.Postgres#v:modifyPgTypes
|
||||
|
||||
[`Result`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Data.Postgres.Result#t:Result
|
||||
[`FromRow`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Data.Postgres.Result#t:FromRow
|
||||
[`FromRows`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Data.Postgres.Result#t:FromRows
|
||||
[`Result`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Data.Postgres.Result#t:Result
|
||||
[`FromRow`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Data.Postgres.Result#t:FromRow
|
||||
[`FromRows`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Data.Postgres.Result#t:FromRows
|
||||
|
||||
[`Query`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Data.Postgres.Query#t:Query
|
||||
[`AsQuery`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Data.Postgres.Query#t:AsQuery
|
||||
[`Query`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Data.Postgres.Query#t:Query
|
||||
[`AsQuery`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Data.Postgres.Query#t:AsQuery
|
||||
|
||||
[`Query.Builder`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Data.Postgres.Query.Builder#t:Builder
|
||||
[`Query.Builder.param`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Data.Postgres.Query.Builder#v:param
|
||||
[`Query.Builder.build`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Data.Postgres.Query.Builder#v:build
|
||||
[`Query.Builder`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Data.Postgres.Query.Builder#t:Builder
|
||||
[`Query.Builder.param`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Data.Postgres.Query.Builder#v:param
|
||||
[`Query.Builder.build`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Data.Postgres.Query.Builder#v:build
|
||||
|
||||
[`MonadCursor`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Control.Monad.Postgres#t:MonadCursor
|
||||
[`MonadSession`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Control.Monad.Postgres#t:MonadSession
|
||||
[`CursorT`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Control.Monad.Postgres#t:CursorT
|
||||
[`SessionT`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Control.Monad.Postgres#t:SessionT
|
||||
[`PostgresT`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Control.Monad.Postgres#t:PostgresT
|
||||
[`cursor`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Control.Monad.Postgres#v:cursor
|
||||
[`session`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Control.Monad.Postgres#v:session
|
||||
[`transaction`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Control.Monad.Postgres#v:transaction
|
||||
[`runPostgres`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Control.Monad.Postgres#v:runPostgres
|
||||
[`query`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Control.Monad.Postgres#v:query
|
||||
[`exec`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Control.Monad.Postgres#v:exec
|
||||
[`exec_`]: https://pursuit.purescript.org///////////packages/purescript-postgresql/1.2.3/docs/Control.Monad.Postgres#v:exec_
|
||||
[`Except`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Effect.Postgres.Error.Except#t:Except
|
||||
[`Error`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Effect.Postgres.Error#t:Error
|
||||
[`Except.run`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Effect.Postgres.Error.Except#v:run
|
||||
|
||||
[`MonadCursor`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Control.Monad.Postgres#t:MonadCursor
|
||||
[`MonadSession`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Control.Monad.Postgres#t:MonadSession
|
||||
[`CursorT`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Control.Monad.Postgres#t:CursorT
|
||||
[`SessionT`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Control.Monad.Postgres#t:SessionT
|
||||
[`PostgresT`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Control.Monad.Postgres#t:PostgresT
|
||||
[`cursor`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Control.Monad.Postgres#v:cursor
|
||||
[`session`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Control.Monad.Postgres#v:session
|
||||
[`transaction`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Control.Monad.Postgres#v:transaction
|
||||
[`runPostgres`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Control.Monad.Postgres#v:runPostgres
|
||||
[`query`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Control.Monad.Postgres#v:query
|
||||
[`exec`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Control.Monad.Postgres#v:exec
|
||||
[`exec_`]: https://pursuit.purescript.org/packages/purescript-postgresql/2.0.20/docs/Control.Monad.Postgres#v:exec_
|
||||
|
||||
[`node-postgres`]: https://node-postgres.com/
|
||||
[`pg-types`]: https://github.com/brianc/node-pg-types/
|
||||
|
||||
@@ -20,7 +20,7 @@ await writeFile('./spago.yaml', spagonew)
|
||||
|
||||
const readme = await readFile('./README.md', 'utf8')
|
||||
const readmenew = readme.replace(
|
||||
/packages\/purescript-postgresql\/.+?\//g,
|
||||
/\/packages\/purescript-postgresql\/.+?\//g,
|
||||
`/packages/purescript-postgresql/${ver}/`,
|
||||
)
|
||||
await writeFile('./README.md', readmenew)
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
{
|
||||
"name": "purs",
|
||||
"name": "purescript-postgresql",
|
||||
"private": true,
|
||||
"module": "index.js",
|
||||
"type": "module",
|
||||
@@ -14,6 +14,9 @@
|
||||
"dependencies": {
|
||||
"decimal.js": "^10.4.3",
|
||||
"pg": "^8.11.3",
|
||||
"pg-copy-streams": "^6.0.6",
|
||||
"pg-listen": "^1.7.0",
|
||||
"postgres-interval": "1.2.0",
|
||||
"postgres-range": "^1.1.4"
|
||||
}
|
||||
}
|
||||
|
||||
3660
spago.lock
3660
spago.lock
File diff suppressed because it is too large
Load Diff
15
spago.yaml
15
spago.yaml
@@ -1,7 +1,7 @@
|
||||
package:
|
||||
name: postgresql
|
||||
publish:
|
||||
version: '1.2.3'
|
||||
version: '2.0.20'
|
||||
license: 'GPL-3.0-or-later'
|
||||
location:
|
||||
githubOwner: 'cakekindel'
|
||||
@@ -25,27 +25,36 @@ package:
|
||||
- foldable-traversable: ">=6.0.0 <7.0.0"
|
||||
- foreign: ">=7.0.0 <8.0.0"
|
||||
- fork: ">=6.0.0 <7.0.0"
|
||||
- functors: ">=5.0.0 <6.0.0"
|
||||
- integers: ">=6.0.0 <7.0.0"
|
||||
- js-bigints: ">=2.2.1 <3.0.0"
|
||||
- lists: ">=7.0.0 <8.0.0"
|
||||
- maybe: ">=6.0.0 <7.0.0"
|
||||
- mmorph: ">=7.0.0 <8.0.0"
|
||||
- monad-control: ">=5.0.0 <6.0.0"
|
||||
- newtype: ">=5.0.0 <6.0.0"
|
||||
- node-buffer: ">=9.0.0 <10.0.0"
|
||||
- node-event-emitter: ">=3.0.0 <4.0.0"
|
||||
- node-stream-pipes: ">=2.1.0 <3.0.0"
|
||||
- node-streams: ">=9.0.0 <10.0.0"
|
||||
- nullable: ">=6.0.0 <7.0.0"
|
||||
- parallel: ">=6.0.0 <7.0.0"
|
||||
- partial: ">=4.0.0 <5.0.0"
|
||||
- pipes: ">=8.0.0 <9.0.0"
|
||||
- precise-datetime: ">=7.0.0 <8.0.0"
|
||||
- prelude: ">=6.0.1 <7.0.0"
|
||||
- profunctor: ">=6.0.1 <7.0.0"
|
||||
- record: ">=4.0.0 <5.0.0"
|
||||
- refs: ">=6.0.0 <7.0.0"
|
||||
- simple-json: ">=9.0.0 <10.0.0"
|
||||
- strings: ">=6.0.1 <7.0.0"
|
||||
- tailrec: ">=6.1.0 <7.0.0"
|
||||
- transformers: ">=6.0.0 <7.0.0"
|
||||
- tuples: ">=7.0.0 <8.0.0"
|
||||
- typelevel-prelude: ">=7.0.0 <8.0.0"
|
||||
- unlift: ">=1.0.1 <2.0.0"
|
||||
- unsafe-coerce: ">=6.0.0 <7.0.0"
|
||||
- node-fs: ">=9.1.0 <9.2.0"
|
||||
test:
|
||||
main: Test.Main
|
||||
dependencies:
|
||||
@@ -53,10 +62,10 @@ package:
|
||||
- foreign-object
|
||||
- node-child-process
|
||||
- node-process
|
||||
- precise-datetime
|
||||
- quickcheck
|
||||
- spec
|
||||
- spec-quickcheck
|
||||
workspace:
|
||||
extraPackages: {}
|
||||
packageSet:
|
||||
registry: 50.5.0
|
||||
registry: 55.1.0
|
||||
|
||||
@@ -2,22 +2,27 @@ module Control.Monad.Postgres.Base where
|
||||
|
||||
import Prelude
|
||||
|
||||
import Control.Alt (class Alt)
|
||||
import Control.Alternative (class Plus)
|
||||
import Control.Monad.Error.Class (class MonadError, class MonadThrow, catchError, throwError)
|
||||
import Control.Monad.Fork.Class (class MonadBracket, class MonadFork, class MonadKill, bracket, kill, never, uninterruptible)
|
||||
import Control.Monad.Morph (class MFunctor, class MMonad)
|
||||
import Control.Monad.Postgres.Session (class MonadSession, SessionT, exec, exec_, query)
|
||||
import Control.Monad.Reader (class MonadAsk, class MonadReader, ReaderT, ask, local, runReaderT)
|
||||
import Control.Monad.Trans.Class (class MonadTrans, lift)
|
||||
import Control.Parallel (class Parallel, parallel, sequential)
|
||||
import Data.Newtype (class Newtype, unwrap, wrap)
|
||||
import Effect.Aff (Fiber)
|
||||
import Control.Monad.Error.Class (catchError, throwError)
|
||||
import Control.Monad.Fork.Class (class MonadBracket, bracket)
|
||||
import Control.Monad.Morph (hoist)
|
||||
import Control.Monad.Postgres.Cursor (class MonadCursor, CursorT)
|
||||
import Control.Monad.Postgres.Session (class MonadSession, SessionT, endSession, exec, exec_, startSession)
|
||||
import Control.Monad.Reader (ask, runReaderT)
|
||||
import Data.Newtype (unwrap)
|
||||
import Data.Postgres (RepT)
|
||||
import Data.Postgres.Query (class AsQuery, asQuery)
|
||||
import Data.Postgres.Raw (Raw)
|
||||
import Data.Postgres.Result (class FromRow, fromRow)
|
||||
import Data.Tuple.Nested ((/\))
|
||||
import Effect.Aff.Class (class MonadAff, liftAff)
|
||||
import Effect.Aff.Postgres.Pool (Pool)
|
||||
import Effect.Aff.Postgres.Pool as Pool
|
||||
import Effect.Class (class MonadEffect, liftEffect)
|
||||
import Effect.Exception (Error)
|
||||
import Effect.Class (liftEffect)
|
||||
import Effect.Exception as Effect
|
||||
import Effect.Postgres.Error (RE)
|
||||
import Effect.Postgres.Error as E
|
||||
import Effect.Postgres.Error.Except as X
|
||||
import Effect.Postgres.Error.RE as RE
|
||||
import Prim.Row (class Union)
|
||||
|
||||
-- | Monad handling pool resource acquisition & release
|
||||
@@ -44,84 +49,75 @@ import Prim.Row (class Union)
|
||||
-- | res <- Client.query "select * from foo" client
|
||||
-- | pure $ res == 1
|
||||
-- | ```
|
||||
newtype PostgresT :: forall k. (k -> Type) -> k -> Type
|
||||
newtype PostgresT m a = PostgresT (ReaderT Pool m a)
|
||||
type PostgresT :: (Type -> Type) -> Type -> Type
|
||||
type PostgresT = RE Pool
|
||||
|
||||
derive instance Newtype (PostgresT m a) _
|
||||
derive newtype instance (Functor m) => Functor (PostgresT m)
|
||||
derive newtype instance (Apply m) => Apply (PostgresT m)
|
||||
derive newtype instance (Applicative m) => Applicative (PostgresT m)
|
||||
derive newtype instance (Plus m) => Plus (PostgresT m)
|
||||
derive newtype instance (Alt m) => Alt (PostgresT m)
|
||||
derive newtype instance (Bind m) => Bind (PostgresT m)
|
||||
derive newtype instance (Monad m) => Monad (PostgresT m)
|
||||
derive newtype instance (MonadEffect m) => MonadEffect (PostgresT m)
|
||||
derive newtype instance (MonadAff m) => MonadAff (PostgresT m)
|
||||
derive newtype instance MonadTrans (PostgresT)
|
||||
derive newtype instance (MonadThrow e m) => MonadThrow e (PostgresT m)
|
||||
derive newtype instance (MonadError e m) => MonadError e (PostgresT m)
|
||||
derive newtype instance (MonadFork f m) => MonadFork f (PostgresT m)
|
||||
derive newtype instance MFunctor PostgresT
|
||||
derive newtype instance MMonad PostgresT
|
||||
instance (Apply m, Apply p, Parallel p m) => Parallel (PostgresT p) (PostgresT m) where
|
||||
parallel = wrap <<< parallel <<< unwrap
|
||||
sequential = wrap <<< sequential <<< unwrap
|
||||
|
||||
instance (Monad m, MonadKill e f m) => MonadKill e f (PostgresT m) where
|
||||
kill a b = lift $ kill a b
|
||||
|
||||
instance (Monad m, MonadBracket e f (ReaderT Pool m), MonadBracket e f m) => MonadBracket e f (PostgresT m) where
|
||||
bracket acq rel m = wrap $ bracket (unwrap acq) (\a b -> unwrap $ rel a b) (unwrap <<< m)
|
||||
uninterruptible a = wrap $ uninterruptible $ unwrap a
|
||||
never = lift $ never
|
||||
|
||||
instance Monad m => MonadAsk Pool (PostgresT m) where
|
||||
ask = wrap ask
|
||||
|
||||
instance Monad m => MonadReader Pool (PostgresT m) where
|
||||
local f m = wrap $ local f $ unwrap m
|
||||
|
||||
instance (MonadBracket e f m, MonadAff m) => MonadSession (PostgresT m) where
|
||||
query = session <<< query
|
||||
exec = session <<< exec
|
||||
exec_ = session <<< exec_
|
||||
|
||||
-- | Lifts a session to `PostgresT`, releasing the client to the pool
|
||||
-- | after execution.
|
||||
session :: forall e f m a. MonadBracket e f m => MonadAff m => MonadSession (SessionT m) => SessionT m a -> PostgresT m a
|
||||
session m = do
|
||||
pool <- ask
|
||||
let
|
||||
acq = liftAff $ Pool.connect pool
|
||||
rel _ c = liftEffect $ Pool.release pool c
|
||||
lift $ bracket acq rel (runReaderT m)
|
||||
|
||||
-- | Lifts a session to `PostgresT`, running the session
|
||||
-- | in a transaction.
|
||||
-- | Typeclass generalizing `PostgresT`. Allows for dependency-injecting different
|
||||
-- | implementations of the idea of a postgres connection.
|
||||
-- |
|
||||
-- | If the session throws an error, the transaction will be
|
||||
-- | rolled back and the error rethrown.
|
||||
transaction :: forall m a. MonadBracket Error Fiber m => MonadAff m => MonadSession (SessionT m) => SessionT m a -> PostgresT m a
|
||||
transaction m =
|
||||
let
|
||||
begin = void $ exec "begin;"
|
||||
commit = m <* exec "commit;"
|
||||
rollback e = exec "rollback;" *> throwError e
|
||||
in
|
||||
session $ begin *> catchError commit rollback
|
||||
-- | - `session` - Session monad (for `PostgresT` this is `SessionT`)
|
||||
-- | - `cursor` - Cursor session monad (for `PostgresT` this is `CursorT`)
|
||||
-- | - `ct` - Open type parameter for cursor type. Don't pin this to a concrete type.
|
||||
class (Monad m, MonadSession session, MonadCursor cursor ct) <= MonadPostgres m session cursor ct | m -> ct cursor session where
|
||||
-- | Run a session in `m`.
|
||||
session :: session ~> m
|
||||
-- | Run a session in `m`, wrapped in a transaction.
|
||||
-- |
|
||||
-- | If any errors are raised, the transaction is rolled back and
|
||||
-- | the error rethrown.
|
||||
transaction :: session ~> m
|
||||
-- | `cursor`, but using a custom deserialize function for the data
|
||||
-- | yielded by the cursor
|
||||
cursorWith :: forall q. AsQuery q => (Array Raw -> RepT ct) -> String -> q -> cursor ~> m
|
||||
|
||||
instance
|
||||
( MonadAff m
|
||||
, MonadSession (SessionT m)
|
||||
, MonadCursor (CursorT t (SessionT m)) t
|
||||
) => MonadPostgres
|
||||
(PostgresT m)
|
||||
(SessionT m)
|
||||
(CursorT ct (SessionT m))
|
||||
ct
|
||||
where
|
||||
session m = do
|
||||
pool <- ask
|
||||
client <- RE.liftExcept $ hoist liftAff $ startSession pool
|
||||
RE.finally
|
||||
(RE.liftExcept $ hoist liftEffect $ endSession pool client)
|
||||
(RE.liftExcept $ RE.toExcept m client)
|
||||
transaction m =
|
||||
let
|
||||
begin = void $ exec "begin;"
|
||||
commit = m <* exec "commit;"
|
||||
rollback e = exec "rollback;" *> throwError e
|
||||
in
|
||||
session $ begin *> catchError commit rollback
|
||||
cursorWith f cur q m =
|
||||
transaction do
|
||||
q' <- RE.liftExcept $ X.printing $ asQuery q
|
||||
exec_ $ "declare " <> cur <> " cursor for (" <> (unwrap q').text <> ");"
|
||||
runReaderT (unwrap m) (cur /\ f)
|
||||
|
||||
-- | Create a server-side cursor for a query in a transaction,
|
||||
-- | and execute a `CursorT` with a view to the new cursor.
|
||||
cursor :: forall @cursort t session cursor q a. MonadPostgres t session cursor cursort => AsQuery q => FromRow cursort => String -> q -> cursor a -> t a
|
||||
cursor = cursorWith (fromRow 0)
|
||||
|
||||
-- | Execute a `PostgresT` using an existing connection pool.
|
||||
-- |
|
||||
-- | This will not invoke `Pool.end` after executing.
|
||||
withPool :: forall m a. PostgresT m a -> Pool -> m a
|
||||
withPool = runReaderT <<< unwrap
|
||||
withPool :: forall m a. PostgresT m a -> Pool -> E.Except m a
|
||||
withPool m p = runReaderT (unwrap m) p
|
||||
|
||||
-- | Create a new connection pool from the provided config and execute
|
||||
-- | the postgres monad, invoking `Effect.Aff.Postgres.Pool.end` afterwards.
|
||||
runPostgres :: forall m a missing trash r e f. MonadBracket e f m => MonadAff m => Union r missing (Pool.Config trash) => Record r -> PostgresT m a -> m a
|
||||
runPostgres :: forall m a missing trash r f. MonadBracket Effect.Error f m => MonadAff m => Union r missing (Pool.Config trash) => Record r -> PostgresT m a -> E.Except m a
|
||||
runPostgres cfg m =
|
||||
let
|
||||
acq :: RE Unit m Pool
|
||||
acq = liftEffect $ Pool.make @r @missing @trash cfg
|
||||
rel _ p = liftAff $ Pool.end p
|
||||
rel :: _ -> Pool -> RE Unit m Unit
|
||||
rel _ p = RE.liftExcept $ hoist liftAff $ Pool.end p
|
||||
in
|
||||
bracket acq rel $ withPool m
|
||||
RE.toExcept (bracket acq rel $ RE.liftExcept <<< withPool m) unit
|
||||
|
||||
@@ -3,27 +3,32 @@ module Control.Monad.Postgres.Cursor where
|
||||
import Prelude
|
||||
|
||||
import Control.Alt (class Alt)
|
||||
import Control.Alternative (class Plus)
|
||||
import Control.Alternative (class Alternative, class Plus)
|
||||
import Control.Monad.Error.Class (class MonadError, class MonadThrow)
|
||||
import Control.Monad.Fork.Class (class MonadBracket, class MonadFork, class MonadKill, bracket, kill, never, uninterruptible)
|
||||
import Control.Monad.Postgres.Base (PostgresT, transaction)
|
||||
import Control.Monad.Postgres.Session (class MonadSession, SessionT, exec, exec_, query)
|
||||
import Control.Monad.Reader (class MonadAsk, class MonadReader, ReaderT, ask, local, runReaderT)
|
||||
import Control.Monad.Postgres.Session (class MonadSession, exec, exec_, query, streamIn, streamOut)
|
||||
import Control.Monad.Reader (class MonadAsk, class MonadReader, ReaderT, ask, local)
|
||||
import Control.Monad.Rec.Class (class MonadRec)
|
||||
import Control.Monad.Trans.Class (class MonadTrans, lift)
|
||||
import Control.Parallel (class Parallel, parallel, sequential)
|
||||
import Data.Array as Array
|
||||
import Data.Maybe (Maybe)
|
||||
import Data.Newtype (class Newtype, unwrap, wrap)
|
||||
import Data.Postgres (RepT, smash)
|
||||
import Data.Postgres.Query (class AsQuery, asQuery)
|
||||
import Data.Postgres.Raw (Raw)
|
||||
import Data.Postgres.Result (class FromRow, fromRow)
|
||||
import Data.Postgres.Result (RowsAffected(..))
|
||||
import Data.Traversable (traverse)
|
||||
import Data.Tuple.Nested (type (/\), (/\))
|
||||
import Effect.Aff (Fiber)
|
||||
import Effect.Aff.Class (class MonadAff)
|
||||
import Effect.Aff.Unlift (class MonadUnliftAff)
|
||||
import Effect.Class (class MonadEffect, liftEffect)
|
||||
import Effect.Exception (Error)
|
||||
import Effect.Unlift (class MonadUnliftEffect)
|
||||
|
||||
data Move
|
||||
-- | `MOVE RELATIVE`
|
||||
= MoveRelative Int
|
||||
-- | `MOVE ABSOLUTE`
|
||||
| MoveTo Int
|
||||
|
||||
newtype CursorT :: forall k. Type -> (k -> Type) -> k -> Type
|
||||
newtype CursorT t m a = CursorT (ReaderT (String /\ (Array Raw -> RepT t)) m a)
|
||||
@@ -34,10 +39,14 @@ derive newtype instance (Apply m) => Apply (CursorT t m)
|
||||
derive newtype instance (Applicative m) => Applicative (CursorT t m)
|
||||
derive newtype instance (Plus m) => Plus (CursorT t m)
|
||||
derive newtype instance (Alt m) => Alt (CursorT t m)
|
||||
derive newtype instance (Alternative m) => Alternative (CursorT t m)
|
||||
derive newtype instance (Bind m) => Bind (CursorT t m)
|
||||
derive newtype instance (Monad m) => Monad (CursorT t m)
|
||||
derive newtype instance (MonadEffect m) => MonadEffect (CursorT t m)
|
||||
derive newtype instance (MonadAff m) => MonadAff (CursorT t m)
|
||||
derive newtype instance MonadRec m => MonadRec (CursorT t m)
|
||||
derive newtype instance (MonadUnliftEffect m) => MonadUnliftEffect (CursorT t m)
|
||||
derive newtype instance (MonadUnliftAff m) => MonadUnliftAff (CursorT t m)
|
||||
derive newtype instance MonadTrans (CursorT t)
|
||||
derive newtype instance (MonadThrow e m) => MonadThrow e (CursorT t m)
|
||||
derive newtype instance (MonadError e m) => MonadError e (CursorT t m)
|
||||
@@ -87,6 +96,9 @@ class (MonadSession m) <= MonadCursor m t where
|
||||
fetch :: Int -> m (Array t)
|
||||
-- | Fetch all remaining rows from the cursor
|
||||
fetchAll :: m (Array t)
|
||||
-- | Change the cursor's position without fetching any data,
|
||||
-- | returning the number of rows skipped.
|
||||
move :: Move -> m Int
|
||||
|
||||
instance (MonadSession m) => MonadCursor (CursorT t m) t where
|
||||
fetch n = do
|
||||
@@ -97,26 +109,22 @@ instance (MonadSession m) => MonadCursor (CursorT t m) t where
|
||||
cur /\ f <- ask
|
||||
raw :: Array (Array Raw) <- query $ "fetch all from " <> cur
|
||||
liftEffect $ smash $ traverse f raw
|
||||
move (MoveTo n) = do
|
||||
cur /\ _ <- ask
|
||||
RowsAffected n' <- query $ ("move absolute $1 from " <> cur) /\ n
|
||||
pure n'
|
||||
move (MoveRelative n) = do
|
||||
cur /\ _ <- ask
|
||||
RowsAffected n' <- query $ ("move relative $1 from " <> cur) /\ n
|
||||
pure n'
|
||||
|
||||
instance (MonadSession m) => MonadSession (CursorT t m) where
|
||||
query = lift <<< query
|
||||
exec = lift <<< exec
|
||||
exec_ = lift <<< exec_
|
||||
streamIn = lift <<< streamIn
|
||||
streamOut = lift <<< streamOut
|
||||
|
||||
-- | Fetch the next row from the cursor
|
||||
fetchOne :: forall m t. MonadCursor m t => m (Maybe t)
|
||||
fetchOne = Array.head <$> fetch 1
|
||||
|
||||
-- | Create a server-side cursor for a query in a transaction,
|
||||
-- | and execute a `CursorT` with a view to the new cursor.
|
||||
cursor :: forall m @t a q. FromRow t => AsQuery q => MonadAff m => MonadBracket Error Fiber m => MonadSession (SessionT m) => String -> q -> CursorT t (SessionT m) a -> PostgresT m a
|
||||
cursor cur q m = cursorWith cur q fromRow m
|
||||
|
||||
-- | `cursor`, but using a custom deserialize function for the data
|
||||
-- | yielded by the cursor
|
||||
cursorWith :: forall m @t a q. AsQuery q => MonadAff m => MonadBracket Error Fiber m => MonadSession (SessionT m) => String -> q -> (Array Raw -> RepT t) -> CursorT t (SessionT m) a -> PostgresT m a
|
||||
cursorWith cur q f m =
|
||||
transaction do
|
||||
q' <- liftEffect $ asQuery q
|
||||
exec_ $ "declare " <> cur <> " cursor for (" <> (unwrap q').text <> ");"
|
||||
runReaderT (unwrap m) (cur /\ f)
|
||||
|
||||
@@ -1,16 +1,45 @@
|
||||
module Control.Monad.Postgres.Session where
|
||||
|
||||
import Prelude
|
||||
import Prelude hiding (join)
|
||||
|
||||
import Control.Monad.Reader (ReaderT, ask)
|
||||
import Control.Monad.Error.Class (class MonadError, catchError, throwError)
|
||||
import Control.Monad.Morph (hoist)
|
||||
import Control.Monad.Reader (ask)
|
||||
import Control.Monad.Trans.Class (lift)
|
||||
import Data.Newtype (wrap)
|
||||
import Data.Postgres.Query (class AsQuery)
|
||||
import Data.Postgres.Result (class FromRows)
|
||||
import Effect (Effect)
|
||||
import Effect.Aff (Aff)
|
||||
import Effect.Aff.Class (class MonadAff, liftAff)
|
||||
import Effect.Aff.Postgres.Client (Client)
|
||||
import Effect.Aff.Postgres.Client as Client
|
||||
import Effect.Aff.Postgres.Pool (Pool)
|
||||
import Effect.Aff.Postgres.Pool as Pool
|
||||
import Effect.Class (class MonadEffect, liftEffect)
|
||||
import Effect.Postgres.Error (RE)
|
||||
import Effect.Postgres.Error as E
|
||||
import Effect.Postgres.Error.Except as X
|
||||
import Effect.Postgres.Error.RE as RE
|
||||
import Effect.Ref as Ref
|
||||
import Node.EventEmitter as Event
|
||||
import Node.Stream (Readable, Stream, Writable)
|
||||
import Node.Stream as Stream
|
||||
|
||||
type SessionT :: forall k. (k -> Type) -> k -> Type
|
||||
type SessionT = ReaderT Client
|
||||
type SessionT :: (Type -> Type) -> Type -> Type
|
||||
type SessionT = RE Client
|
||||
|
||||
class MonadStartSession a where
|
||||
startSession :: a -> E.Except Aff Client
|
||||
endSession :: a -> Client -> E.Except Effect Unit
|
||||
|
||||
instance MonadStartSession Pool where
|
||||
startSession = Pool.connect
|
||||
endSession p c = Pool.release p c
|
||||
|
||||
instance MonadStartSession Client where
|
||||
startSession = pure
|
||||
endSession _ _ = pure unit
|
||||
|
||||
-- | A monad representing a connected session to a database
|
||||
class MonadAff m <= MonadSession m where
|
||||
@@ -20,12 +49,63 @@ class MonadAff m <= MonadSession m where
|
||||
exec :: forall q. AsQuery q => q -> m Int
|
||||
-- | Executes a query and discards the result
|
||||
exec_ :: forall q. AsQuery q => q -> m Unit
|
||||
-- | Execute a query with a `Writable` stream to `STDIN`
|
||||
-- |
|
||||
-- | Use with `COPY .. FROM` like so:
|
||||
-- |
|
||||
-- | ```purescript
|
||||
-- | w <- streamIn "COPY foo FROM STDIN WITH (FORMAT CSV, HEADER true)"
|
||||
-- | liftEffect $ Stream.writeString "bar\n\"my bar column\"" UTF8 w
|
||||
-- | ```
|
||||
streamIn :: String -> m (Writable ())
|
||||
-- | Execute a query with a `Readable` stream from `STDOUT`
|
||||
-- |
|
||||
-- | Use with `COPY .. TO` like so:
|
||||
-- |
|
||||
-- | ```purescript
|
||||
-- | r <- streamIn "COPY foo TO STDIN WITH (FORMAT CSV, HEADER true)"
|
||||
-- | liftEffect $ Stream.readString r -- "bar\n\"my bar column\""
|
||||
-- | ```
|
||||
streamOut :: String -> m (Readable ())
|
||||
|
||||
instance MonadAff m => MonadSession (SessionT m) where
|
||||
instance (MonadStartSession s, MonadAff m) => MonadSession (RE s m) where
|
||||
query q = do
|
||||
client <- ask
|
||||
liftAff $ Client.query q client
|
||||
pool <- ask
|
||||
client <- hoist liftAff $ RE.liftExcept $ startSession pool
|
||||
RE.finally
|
||||
(hoist liftEffect $ RE.liftExcept $ endSession pool client)
|
||||
(wrap $ lift $ hoist liftAff $ Client.query q client)
|
||||
exec q = do
|
||||
client <- ask
|
||||
liftAff $ Client.exec q client
|
||||
pool <- ask
|
||||
client <- hoist liftAff $ RE.liftExcept $ startSession pool
|
||||
RE.finally
|
||||
(hoist liftEffect $ RE.liftExcept $ endSession pool client)
|
||||
(wrap $ lift $ hoist liftAff $ Client.exec q client)
|
||||
exec_ = void <<< exec
|
||||
streamIn q = do
|
||||
pool <- ask
|
||||
client <- hoist liftAff $ RE.liftExcept $ startSession pool
|
||||
handleStream (X.run $ endSession pool client) (RE.liftExcept $ hoist liftEffect $ Client.execWithStdin q client)
|
||||
streamOut q = do
|
||||
pool <- ask
|
||||
client <- hoist liftAff $ RE.liftExcept $ startSession pool
|
||||
handleStream (X.run $ endSession pool client) (RE.liftExcept $ hoist liftEffect $ Client.queryWithStdout q client)
|
||||
|
||||
handleStream :: forall e m r. MonadEffect m => MonadError e m => Effect Unit -> m (Stream r) -> m (Stream r)
|
||||
handleStream onError getStream =
|
||||
flip catchError
|
||||
(\e -> liftEffect onError *> throwError e)
|
||||
do
|
||||
stream <- getStream
|
||||
liftEffect $ onErrorOrClose stream onError
|
||||
pure stream
|
||||
|
||||
onErrorOrClose :: forall r. Stream r -> Effect Unit -> Effect Unit
|
||||
onErrorOrClose stream eff = do
|
||||
did <- Ref.new false
|
||||
let
|
||||
onE = do
|
||||
did' <- Ref.read did
|
||||
when (not did') (Ref.write true did *> eff)
|
||||
Event.once_ Stream.errorH (const onE) stream
|
||||
Event.once_ Stream.closeH onE stream
|
||||
|
||||
@@ -2,20 +2,13 @@ module Data.Postgres.Custom where
|
||||
|
||||
import Prelude
|
||||
|
||||
import Control.Monad.Except (ExceptT)
|
||||
import Data.Either (hush)
|
||||
import Data.List.NonEmpty (NonEmptyList)
|
||||
import Data.Maybe (Maybe, fromJust)
|
||||
import Data.Postgres.Raw (Raw)
|
||||
import Data.Maybe (fromJust)
|
||||
import Data.String as String
|
||||
import Data.String.Regex (Regex)
|
||||
import Data.String.Regex as Regex
|
||||
import Data.String.Regex.Flags as Regex.Flags
|
||||
import Effect (Effect)
|
||||
import Foreign (ForeignError)
|
||||
import Partial.Unsafe (unsafePartial)
|
||||
import Type.Data.Symbol (reflectSymbol)
|
||||
import Type.Prelude (class IsSymbol, Proxy(..))
|
||||
|
||||
quoted :: String -> String
|
||||
quoted s = "'" <> s <> "'"
|
||||
|
||||
30
src/Data.Postgres.Interval.js
Normal file
30
src/Data.Postgres.Interval.js
Normal file
@@ -0,0 +1,30 @@
|
||||
import PostgresInterval from 'postgres-interval'
|
||||
|
||||
/** @typedef {import('postgres-interval').IPostgresInterval} I */
|
||||
|
||||
/** @type {(o: {years: number, months: number, days: number, hours: number, minutes: number, seconds: number, milliseconds: number}) => I} */
|
||||
export const make = o => Object.assign(PostgresInterval(''), o)
|
||||
|
||||
/** @type {(s: string) => () => I} */
|
||||
export const parse = s => () => PostgresInterval(s)
|
||||
|
||||
/** @type {(a: I) => number} */
|
||||
export const getYears = i => i.years || 0.0
|
||||
|
||||
/** @type {(a: I) => number} */
|
||||
export const getMonths = i => i.months || 0.0
|
||||
|
||||
/** @type {(a: I) => number} */
|
||||
export const getDays = i => i.days || 0.0
|
||||
|
||||
/** @type {(a: I) => number} */
|
||||
export const getMinutes = i => i.minutes || 0.0
|
||||
|
||||
/** @type {(a: I) => number} */
|
||||
export const getHours = i => i.hours || 0.0
|
||||
|
||||
/** @type {(a: I) => number} */
|
||||
export const getSeconds = i => i.seconds || 0.0
|
||||
|
||||
/** @type {(a: I) => number} */
|
||||
export const getMilliseconds = i => i.milliseconds || 0.0
|
||||
88
src/Data.Postgres.Interval.purs
Normal file
88
src/Data.Postgres.Interval.purs
Normal file
@@ -0,0 +1,88 @@
|
||||
module Data.Postgres.Interval where
|
||||
|
||||
import Prelude
|
||||
|
||||
import Data.Int as Int
|
||||
import Data.Maybe (Maybe(..))
|
||||
import Data.Newtype (unwrap)
|
||||
import Data.Time.Duration (class Duration, Days(..), Hours(..), Milliseconds(..), Minutes(..), Seconds(..), convertDuration)
|
||||
import Effect (Effect)
|
||||
|
||||
zero :: IntervalRecord
|
||||
zero = {years: 0, months: 0, days: 0, hours: 0, minutes: 0, seconds: 0, milliseconds: 0.0}
|
||||
|
||||
type IntervalRecord =
|
||||
{ years :: Int
|
||||
, months :: Int
|
||||
, days :: Int
|
||||
, hours :: Int
|
||||
, minutes :: Int
|
||||
, seconds :: Int
|
||||
, milliseconds :: Number
|
||||
}
|
||||
|
||||
foreign import data Interval :: Type
|
||||
|
||||
foreign import make :: IntervalRecord -> Interval
|
||||
foreign import parse :: String -> Effect Interval
|
||||
|
||||
foreign import getYears :: Interval -> Int
|
||||
foreign import getMonths :: Interval -> Int
|
||||
foreign import getDays :: Interval -> Int
|
||||
foreign import getHours :: Interval -> Int
|
||||
foreign import getMinutes :: Interval -> Int
|
||||
foreign import getSeconds :: Interval -> Int
|
||||
foreign import getMilliseconds :: Interval -> Number
|
||||
|
||||
toDuration :: forall d. Semigroup d => Duration d => Interval -> Maybe d
|
||||
toDuration a =
|
||||
let
|
||||
includesMonths = getYears a > 0 || getMonths a > 0
|
||||
|
||||
days :: d
|
||||
days = convertDuration $ Days $ Int.toNumber $ getDays a
|
||||
|
||||
hours :: d
|
||||
hours = convertDuration $ Hours $ Int.toNumber $ getHours a
|
||||
|
||||
minutes :: d
|
||||
minutes = convertDuration $ Minutes $ Int.toNumber $ getMinutes a
|
||||
|
||||
seconds :: d
|
||||
seconds = convertDuration $ Seconds $ Int.toNumber $ getSeconds a
|
||||
|
||||
milliseconds :: d
|
||||
milliseconds = convertDuration $ Milliseconds $ getMilliseconds a
|
||||
in
|
||||
if includesMonths then Nothing else Just (days <> hours <> minutes <> seconds <> milliseconds)
|
||||
|
||||
toRecord :: Interval -> IntervalRecord
|
||||
toRecord a =
|
||||
{ years: getYears a
|
||||
, months: getMonths a
|
||||
, days: getDays a
|
||||
, hours: getHours a
|
||||
, minutes: getMinutes a
|
||||
, seconds: getSeconds a
|
||||
, milliseconds: getMilliseconds a
|
||||
}
|
||||
|
||||
fromDuration :: forall d. Duration d => d -> Interval
|
||||
fromDuration a =
|
||||
let
|
||||
millisTotal :: Number
|
||||
millisTotal = (unwrap :: Milliseconds -> Number) $ convertDuration a
|
||||
secondFactor = 1000.0
|
||||
minuteFactor = 60.0 * secondFactor
|
||||
hourFactor = 60.0 * minuteFactor
|
||||
dayFactor = 24.0 * hourFactor
|
||||
days = Int.trunc $ millisTotal / dayFactor
|
||||
daysRem = millisTotal - (Int.toNumber days * dayFactor)
|
||||
hours = Int.trunc $ daysRem / hourFactor
|
||||
hoursRem = daysRem - (Int.toNumber hours * hourFactor)
|
||||
minutes = Int.trunc $ hoursRem / minuteFactor
|
||||
minutesRem = hoursRem - (Int.toNumber minutes * minuteFactor)
|
||||
seconds = Int.trunc $ minutesRem / secondFactor
|
||||
milliseconds = minutesRem - (Int.toNumber seconds * secondFactor)
|
||||
in
|
||||
make {years: 0, months: 0, days, hours, minutes, seconds, milliseconds}
|
||||
@@ -2,10 +2,11 @@ module Data.Postgres.Query where
|
||||
|
||||
import Prelude
|
||||
|
||||
import Control.Monad.Cont (lift)
|
||||
import Data.Maybe (Maybe(..))
|
||||
import Data.Newtype (class Newtype)
|
||||
import Data.Nullable (Nullable, toNullable)
|
||||
import Data.Postgres (class Rep, serialize, smash)
|
||||
import Data.Postgres (class Rep, RepT, serialize)
|
||||
import Data.Postgres.Raw (Raw)
|
||||
import Data.Tuple.Nested (type (/\), (/\))
|
||||
import Effect (Effect)
|
||||
@@ -30,26 +31,29 @@ derive newtype instance Show Query
|
||||
emptyQuery :: Query
|
||||
emptyQuery = Query { text: "", values: [], name: Nothing }
|
||||
|
||||
stringQuery :: String -> Query
|
||||
stringQuery s = Query { text: s, values: [], name: Nothing }
|
||||
|
||||
-- | Any value that can be converted to an array of query parameters
|
||||
class AsQueryParams a where
|
||||
asQueryParams :: a -> Effect (Array Raw)
|
||||
asQueryParams :: a -> RepT (Array Raw)
|
||||
|
||||
instance AsQueryParams (Array Raw) where
|
||||
asQueryParams = pure
|
||||
else instance (Rep a, AsQueryParams b) => AsQueryParams (a /\ b) where
|
||||
asQueryParams (a /\ tail) = do
|
||||
a' <- map pure $ smash $ serialize a
|
||||
a' <- map pure $ serialize a
|
||||
tail' <- asQueryParams tail
|
||||
pure $ a' <> tail'
|
||||
else instance (Rep a) => AsQueryParams a where
|
||||
asQueryParams = map pure <<< smash <<< serialize
|
||||
asQueryParams = map pure <<< serialize
|
||||
|
||||
-- | Values that can be rendered as a SQL query
|
||||
class AsQuery a where
|
||||
asQuery :: a -> Effect Query
|
||||
asQuery :: a -> RepT Query
|
||||
|
||||
instance AsQuery a => AsQuery (Effect a) where
|
||||
asQuery a = asQuery =<< a
|
||||
asQuery a = asQuery =<< lift a
|
||||
|
||||
instance AsQuery Query where
|
||||
asQuery = pure
|
||||
|
||||
@@ -2,13 +2,15 @@ module Data.Postgres.Result where
|
||||
|
||||
import Prelude
|
||||
|
||||
import Control.Monad.Error.Class (liftMaybe, throwError)
|
||||
import Control.Monad.Error.Class (catchError, liftMaybe, throwError)
|
||||
import Data.Array as Array
|
||||
import Data.Generic.Rep (class Generic)
|
||||
import Data.Int as Int
|
||||
import Data.Maybe (Maybe)
|
||||
import Data.Newtype (class Newtype)
|
||||
import Data.Nullable (Nullable)
|
||||
import Data.Nullable as Nullable
|
||||
import Data.Postgres (class Deserialize, class Rep, RepT, deserialize)
|
||||
import Data.Postgres (class Deserialize, RepT, deserialize)
|
||||
import Data.Postgres.Raw (Raw)
|
||||
import Data.Traversable (traverse)
|
||||
import Data.Tuple (Tuple)
|
||||
@@ -27,19 +29,29 @@ foreign import data Result :: Type
|
||||
rowsAffected :: Result -> Maybe Int
|
||||
rowsAffected = Int.fromNumber <=< Nullable.toMaybe <<< __rowsAffected
|
||||
|
||||
class FromRows a where
|
||||
fromRows :: Array (Array Raw) -> RepT a
|
||||
newtype RowsAffected = RowsAffected Int
|
||||
|
||||
instance (FromRow a) => FromRows (Array a) where
|
||||
fromRows = traverse fromRow
|
||||
derive instance Newtype RowsAffected _
|
||||
derive instance Generic RowsAffected _
|
||||
derive newtype instance Eq RowsAffected
|
||||
derive newtype instance Ord RowsAffected
|
||||
derive newtype instance Show RowsAffected
|
||||
|
||||
class FromRows a where
|
||||
fromRows :: RowsAffected -> Array (Array Raw) -> RepT a
|
||||
|
||||
instance FromRows RowsAffected where
|
||||
fromRows a _ = pure a
|
||||
else instance (FromRow a) => FromRows (Array a) where
|
||||
fromRows _ = traverse (fromRow 0)
|
||||
else instance (FromRow a) => FromRows (Maybe a) where
|
||||
fromRows = map Array.head <<< traverse fromRow
|
||||
fromRows _ = map Array.head <<< traverse (fromRow 0)
|
||||
else instance (FromRow a) => FromRows a where
|
||||
fromRows =
|
||||
fromRows a =
|
||||
let
|
||||
e = pure $ ForeignError $ "Expected at least 1 row"
|
||||
in
|
||||
liftMaybe e <=< fromRows @(Maybe a)
|
||||
liftMaybe e <=< fromRows @(Maybe a) a
|
||||
|
||||
-- | Can be unmarshalled from a queried row
|
||||
-- |
|
||||
@@ -77,29 +89,34 @@ class FromRow (a :: Type) where
|
||||
-- | Minimum length of row for type `a`
|
||||
minColumnCount :: forall g. g a -> Int
|
||||
-- | Performs the conversion
|
||||
fromRow :: Array Raw -> RepT a
|
||||
fromRow :: Int -> Array Raw -> RepT a
|
||||
|
||||
instance (Deserialize a, FromRow b) => FromRow (a /\ b) where
|
||||
minColumnCount _ = minColumnCount (Proxy @b) + 1
|
||||
fromRow r =
|
||||
fromRow n r =
|
||||
let
|
||||
minLen = minColumnCount (Proxy @(Tuple a b))
|
||||
lengthMismatch = pure $ TypeMismatch ("Expected row to have at least " <> show minLen <> " columns") ("Found row of length " <> show (Array.length r))
|
||||
in
|
||||
do
|
||||
let
|
||||
de a =
|
||||
catchError
|
||||
(deserialize @a a)
|
||||
(\e -> throwError $ ErrorAtIndex n <$> e)
|
||||
when (Array.length r < minLen) (throwError lengthMismatch)
|
||||
a <- deserialize =<< liftMaybe lengthMismatch (Array.head r)
|
||||
b <- fromRow =<< liftMaybe lengthMismatch (Array.tail r)
|
||||
a <- de =<< liftMaybe lengthMismatch (Array.head r)
|
||||
b <- fromRow (n + 1) =<< liftMaybe lengthMismatch (Array.tail r)
|
||||
pure $ a /\ b
|
||||
else instance FromRow (Array Raw) where
|
||||
minColumnCount _ = 0
|
||||
fromRow = pure
|
||||
fromRow _ = pure
|
||||
else instance FromRow Unit where
|
||||
minColumnCount _ = 0
|
||||
fromRow _ = pure unit
|
||||
fromRow _ _ = pure unit
|
||||
else instance Deserialize a => FromRow a where
|
||||
minColumnCount _ = 1
|
||||
fromRow r =
|
||||
fromRow _ r =
|
||||
let
|
||||
err = pure $ TypeMismatch "Expected row of length >= 1" "Empty row"
|
||||
in
|
||||
|
||||
@@ -13,15 +13,15 @@ import Effect.Class (liftEffect)
|
||||
import Foreign (ForeignError(..))
|
||||
|
||||
-- | Monad used to incrementally deserialize columns from a row
|
||||
type Unresult a = StateT {ix :: Int, row :: Array Raw} RepT a
|
||||
type Unresult a = StateT { ix :: Int, row :: Array Raw } RepT a
|
||||
|
||||
-- | Run an `UnresultT`
|
||||
unresult :: forall a. Unresult a -> Array Raw -> RepT a
|
||||
unresult m row = fst <$> runStateT m {ix: 0, row}
|
||||
unresult m row = fst <$> runStateT m { ix: 0, row }
|
||||
|
||||
-- | Take the next column from the row, unmarshalling into `a`
|
||||
take :: forall a. Deserialize a => Unresult a
|
||||
take = do
|
||||
raw <- state (\r -> Array.index r.row r.ix /\ r {ix = r.ix + 1})
|
||||
raw <- state (\r -> Array.index r.row r.ix /\ r { ix = r.ix + 1 })
|
||||
raw' <- liftMaybe (pure $ ForeignError $ "Ran out of columns!") raw
|
||||
liftEffect $ smash $ deserialize raw'
|
||||
|
||||
@@ -1,5 +1,24 @@
|
||||
import Pg from 'pg'
|
||||
import Range from 'postgres-range'
|
||||
import { Buffer } from 'buffer'
|
||||
import PostgresInterval from 'postgres-interval'
|
||||
|
||||
/** @type {(a: unknown) => boolean} */
|
||||
export const isInstanceOfBuffer = a => a instanceof Buffer
|
||||
|
||||
/** @type {(a: unknown) => boolean} */
|
||||
export const isInstanceOfInterval = a => {
|
||||
return typeof a === 'object'
|
||||
&& a !== null
|
||||
&& ('years' in a
|
||||
|| 'months' in a
|
||||
|| 'days' in a
|
||||
|| 'hours' in a
|
||||
|| 'minutes' in a
|
||||
|| 'seconds' in a
|
||||
|| 'milliseconds' in a
|
||||
)
|
||||
}
|
||||
|
||||
export const modifyPgTypes = () => {
|
||||
// https://github.com/brianc/node-pg-types/blob/master/lib/textParsers.js
|
||||
|
||||
@@ -3,23 +3,28 @@ module Data.Postgres where
|
||||
import Prelude
|
||||
|
||||
import Control.Alt ((<|>))
|
||||
import Control.Monad.Error.Class (liftEither, liftMaybe)
|
||||
import Control.Monad.Error.Class (liftEither, liftMaybe, throwError)
|
||||
import Control.Monad.Except (ExceptT, runExceptT)
|
||||
import Control.Monad.Morph (hoist)
|
||||
import Control.Monad.Trans.Class (lift)
|
||||
import Data.Bifunctor (lmap)
|
||||
import Data.DateTime (DateTime)
|
||||
import Data.DateTime.Instant (Instant)
|
||||
import Data.DateTime.Instant as Instant
|
||||
import Data.List.NonEmpty (NonEmptyList)
|
||||
import Data.Maybe (Maybe(..))
|
||||
import Data.Newtype (class Newtype, unwrap, wrap)
|
||||
import Data.Postgres.Interval (Interval)
|
||||
import Data.Postgres.Interval as Interval
|
||||
import Data.Postgres.Range (Range, __rangeFromRecord, __rangeRawFromRaw, __rangeRawFromRecord, __rangeRawToRecord, __rangeToRecord)
|
||||
import Data.Postgres.Raw (Null(..), Raw, jsNull)
|
||||
import Data.Postgres.Raw (unsafeFromForeign, asForeign) as Raw
|
||||
import Data.RFC3339String as DateTime.ISO
|
||||
import Data.Time.Duration (Days, Hours, Milliseconds, Minutes, Seconds)
|
||||
import Data.Traversable (traverse)
|
||||
import Effect (Effect)
|
||||
import Effect.Exception (error)
|
||||
import Foreign (ForeignError(..), unsafeToForeign)
|
||||
import Foreign (ForeignError(..), tagOf, unsafeFromForeign, unsafeToForeign)
|
||||
import Foreign as F
|
||||
import JS.BigInt (BigInt)
|
||||
import JS.BigInt as BigInt
|
||||
@@ -40,6 +45,9 @@ derive newtype instance ReadForeign a => ReadForeign (JSON a)
|
||||
-- | for some types to unmarshal as strings rather than JS values.
|
||||
foreign import modifyPgTypes :: Effect Unit
|
||||
|
||||
foreign import isInstanceOfBuffer :: F.Foreign -> Boolean
|
||||
foreign import isInstanceOfInterval :: F.Foreign -> Boolean
|
||||
|
||||
-- | The serialization & deserialization monad.
|
||||
type RepT = ExceptT (NonEmptyList ForeignError) Effect
|
||||
|
||||
@@ -68,6 +76,9 @@ instance (Serialize a, Deserialize a) => Rep a
|
||||
unsafeSerializeCoerce :: forall m a. Monad m => a -> m Raw
|
||||
unsafeSerializeCoerce = pure <<< Raw.unsafeFromForeign <<< F.unsafeToForeign
|
||||
|
||||
invalidDuration :: NonEmptyList ForeignError
|
||||
invalidDuration = pure $ ForeignError $ "Can't convert interval with year or month components to Milliseconds"
|
||||
|
||||
instance Serialize Raw where
|
||||
serialize = pure
|
||||
|
||||
@@ -107,10 +118,38 @@ instance Serialize String where
|
||||
instance Serialize Number where
|
||||
serialize = unsafeSerializeCoerce
|
||||
|
||||
-- | `timestamp`, `timestamptz`
|
||||
-- | `interval`
|
||||
instance Serialize DateTime where
|
||||
serialize = serialize <<< unwrap <<< DateTime.ISO.fromDateTime
|
||||
|
||||
-- | `interval`
|
||||
instance Serialize Interval where
|
||||
serialize = unsafeSerializeCoerce
|
||||
|
||||
-- | `interval`
|
||||
instance Serialize Milliseconds where
|
||||
serialize = serialize <<< Interval.fromDuration
|
||||
|
||||
-- | `interval`
|
||||
instance Serialize Seconds where
|
||||
serialize = serialize <<< Interval.fromDuration
|
||||
|
||||
-- | `interval`
|
||||
instance Serialize Minutes where
|
||||
serialize = serialize <<< Interval.fromDuration
|
||||
|
||||
-- | `interval`
|
||||
instance Serialize Hours where
|
||||
serialize = serialize <<< Interval.fromDuration
|
||||
|
||||
-- | `interval`
|
||||
instance Serialize Days where
|
||||
serialize = serialize <<< Interval.fromDuration
|
||||
|
||||
-- | `timestamp`, `timestamptz`
|
||||
instance Serialize Instant where
|
||||
serialize = serialize <<< Instant.toDateTime
|
||||
|
||||
-- | `Just` -> `a`, `Nothing` -> `NULL`
|
||||
instance Serialize a => Serialize (Maybe a) where
|
||||
serialize (Just a) = serialize a
|
||||
@@ -142,7 +181,41 @@ instance ReadForeign a => Deserialize (JSON a) where
|
||||
|
||||
-- | `bytea`
|
||||
instance Deserialize Buffer where
|
||||
deserialize = (F.unsafeReadTagged "Buffer") <<< Raw.asForeign
|
||||
deserialize =
|
||||
let
|
||||
notBuffer a = pure $ TypeMismatch (tagOf a) "Buffer"
|
||||
readBuffer a = when (not $ isInstanceOfBuffer a) (throwError $ notBuffer a) $> unsafeFromForeign a
|
||||
in
|
||||
readBuffer <<< Raw.asForeign
|
||||
|
||||
-- | `interval`
|
||||
instance Deserialize Interval where
|
||||
deserialize =
|
||||
let
|
||||
notInterval a = pure $ TypeMismatch (tagOf a) "Interval"
|
||||
readInterval a = when (not $ isInstanceOfInterval a) (throwError $ notInterval a) $> unsafeFromForeign a
|
||||
in
|
||||
readInterval <<< Raw.asForeign
|
||||
|
||||
-- | `interval`
|
||||
instance Deserialize Milliseconds where
|
||||
deserialize = flip bind (liftMaybe invalidDuration) <<< map Interval.toDuration <<< deserialize
|
||||
|
||||
-- | `interval`
|
||||
instance Deserialize Seconds where
|
||||
deserialize = flip bind (liftMaybe invalidDuration) <<< map Interval.toDuration <<< deserialize
|
||||
|
||||
-- | `interval`
|
||||
instance Deserialize Minutes where
|
||||
deserialize = flip bind (liftMaybe invalidDuration) <<< map Interval.toDuration <<< deserialize
|
||||
|
||||
-- | `interval`
|
||||
instance Deserialize Hours where
|
||||
deserialize = flip bind (liftMaybe invalidDuration) <<< map Interval.toDuration <<< deserialize
|
||||
|
||||
-- | `interval`
|
||||
instance Deserialize Days where
|
||||
deserialize = flip bind (liftMaybe invalidDuration) <<< map Interval.toDuration <<< deserialize
|
||||
|
||||
-- | `int2`, `int4`
|
||||
instance Deserialize Int where
|
||||
@@ -176,6 +249,10 @@ instance Deserialize DateTime where
|
||||
let invalid = pure $ ForeignError $ "Not a valid ISO8601 string: `" <> s <> "`"
|
||||
liftMaybe invalid $ DateTime.ISO.toDateTime $ wrap s
|
||||
|
||||
-- | `timestamp`, `timestamptz`
|
||||
instance Deserialize Instant where
|
||||
deserialize = map Instant.fromDateTime <<< deserialize
|
||||
|
||||
-- | postgres `array`
|
||||
instance Deserialize a => Deserialize (Array a) where
|
||||
deserialize = traverse (deserialize <<< Raw.unsafeFromForeign) <=< F.readArray <<< Raw.asForeign
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
import QueryStream from 'pg-copy-streams'
|
||||
|
||||
/** @type {(c: import('pg').Client) => () => Promise<void>} */
|
||||
export const __connect = c => () => c.connect()
|
||||
|
||||
@@ -6,3 +8,9 @@ export const __end = c => () => c.end()
|
||||
|
||||
/** @type {(q: import('pg').QueryConfig) => (c: import('pg').Client) => () => Promise<import('pg').QueryResult>} */
|
||||
export const __query = q => c => () => c.query(q)
|
||||
|
||||
/** @type {(q: string) => (c: import('pg').Client) => () => import('stream').Readable} */
|
||||
export const __execStreamStdout = q => c => () => c.query(QueryStream.to(q))
|
||||
|
||||
/** @type {(q: string) => (c: import('pg').Client) => () => import('stream').Writable} */
|
||||
export const __execStreamStdin = q => c => () => c.query(QueryStream.from(q))
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
module Effect.Aff.Postgres.Client (connected, connect, end, exec, query, queryRaw, __connect, __end, __query, module X) where
|
||||
module Effect.Aff.Postgres.Client (connected, connect, end, exec, execWithStdin, queryWithStdout, query, queryRaw, __connect, __end, __query, __execStreamStdin, __execStreamStdout, module Reexport) where
|
||||
|
||||
import Prelude
|
||||
|
||||
@@ -6,14 +6,17 @@ import Control.Promise (Promise)
|
||||
import Control.Promise as Promise
|
||||
import Data.Functor (voidRight)
|
||||
import Data.Maybe (fromMaybe)
|
||||
import Data.Postgres (smash)
|
||||
import Data.Postgres.Query (class AsQuery, QueryRaw, asQuery, __queryToRaw)
|
||||
import Data.Newtype (wrap)
|
||||
import Data.Postgres.Query (class AsQuery, QueryRaw, __queryToRaw, asQuery, stringQuery)
|
||||
import Data.Postgres.Result (class FromRows, Result, fromRows, rows, rowsAffected)
|
||||
import Effect (Effect)
|
||||
import Effect.Aff (Aff)
|
||||
import Effect.Class (liftEffect)
|
||||
import Effect.Postgres.Client (Client, ClientConfigRaw, Config, Notification, NotificationRaw, __make, __uncfg, endE, errorE, make, noticeE, notificationE) as Reexport
|
||||
import Effect.Postgres.Client (Client, Config, make)
|
||||
import Effect.Postgres.Client (Client, ClientConfigRaw, Config, Notification, NotificationRaw, __make, __uncfg, endE, errorE, make, noticeE, notificationE) as X
|
||||
import Effect.Postgres.Error as E
|
||||
import Effect.Postgres.Error.Except as X
|
||||
import Node.Stream (Readable, Writable)
|
||||
import Prim.Row (class Union)
|
||||
|
||||
-- | Create a client and immediately connect it to the database
|
||||
@@ -21,8 +24,8 @@ import Prim.Row (class Union)
|
||||
-- | The config parameter `r` is `Config` with all keys optional.
|
||||
-- |
|
||||
-- | This is a shorthand for `(voidRight <*> connect) =<< liftEffect (make cfg)`
|
||||
connected :: forall r missing trash. Union r missing (Config trash) => Record r -> Aff Client
|
||||
connected cfg = (voidRight <*> connect) =<< liftEffect (make @r @missing @trash cfg)
|
||||
connected :: forall r missing trash. Union r missing (Config trash) => Record r -> E.Except Aff Client
|
||||
connected cfg = X.with E.Connecting $ (voidRight <*> connect) =<< liftEffect (make @r @missing @trash cfg)
|
||||
|
||||
-- | Connects the client to the database
|
||||
-- |
|
||||
@@ -33,30 +36,43 @@ connect = Promise.toAffE <<< __connect
|
||||
-- | Disconnects the client from the database
|
||||
-- |
|
||||
-- | <https://node-postgres.com/apis/client#clientend>
|
||||
end :: Client -> Aff Unit
|
||||
end = Promise.toAffE <<< __end
|
||||
end :: Client -> E.Except Aff Unit
|
||||
end = X.with E.Disconnecting <<< Promise.toAffE <<< __end
|
||||
|
||||
-- | Performs a query, returning the raw `Result` object
|
||||
-- |
|
||||
-- | <https://node-postgres.com/apis/client#clientquery>
|
||||
queryRaw :: forall q. AsQuery q => q -> Client -> Aff Result
|
||||
queryRaw :: forall q. AsQuery q => q -> Client -> E.Except Aff Result
|
||||
queryRaw q c = do
|
||||
q' <- __queryToRaw <$> liftEffect (asQuery q)
|
||||
Promise.toAffE $ __query q' c
|
||||
q' <- X.printing $ asQuery q
|
||||
let q'' = __queryToRaw q'
|
||||
X.executing q' $ Promise.toAffE $ __query q'' c
|
||||
|
||||
-- | Performs a query that we expect to not yield any rows,
|
||||
-- | returning the number of rows affected by the statement.
|
||||
-- |
|
||||
-- | <https://node-postgres.com/apis/client#clientquery>
|
||||
exec :: forall q. AsQuery q => q -> Client -> Aff Int
|
||||
exec :: forall q. AsQuery q => q -> Client -> E.Except Aff Int
|
||||
exec q = map (fromMaybe 0 <<< rowsAffected) <<< queryRaw q
|
||||
|
||||
-- | Performs a query that we expect to yield rows,
|
||||
-- | returning them unmarshalled into destination type `r`.
|
||||
-- |
|
||||
-- | <https://node-postgres.com/apis/client#clientquery>
|
||||
query :: forall q r. AsQuery q => FromRows r => q -> Client -> Aff r
|
||||
query q = (liftEffect <<< smash <<< fromRows) <=< map rows <<< queryRaw q
|
||||
query :: forall q r. AsQuery q => FromRows r => q -> Client -> E.Except Aff r
|
||||
query q c = do
|
||||
q' <- X.printing $ asQuery q
|
||||
raw <- queryRaw q c
|
||||
let
|
||||
affected = rowsAffected raw
|
||||
rows' = rows raw
|
||||
X.parsing q' $ fromRows (wrap $ fromMaybe 0 affected) rows'
|
||||
|
||||
execWithStdin :: String -> Client -> E.Except Effect (Writable ())
|
||||
execWithStdin q c = X.executing (stringQuery q) $ __execStreamStdin q c
|
||||
|
||||
queryWithStdout :: String -> Client -> E.Except Effect (Readable ())
|
||||
queryWithStdout q c = X.executing (stringQuery q) $ __execStreamStdout q c
|
||||
|
||||
-- | FFI binding to `Client#connect`
|
||||
foreign import __connect :: Client -> Effect (Promise Unit)
|
||||
@@ -66,3 +82,9 @@ foreign import __end :: Client -> Effect (Promise Unit)
|
||||
|
||||
-- | FFI binding to `Client#query`
|
||||
foreign import __query :: QueryRaw -> Client -> Effect (Promise Result)
|
||||
|
||||
-- | FFI binding to `import('pg-copy-streams').to`
|
||||
foreign import __execStreamStdout :: String -> Client -> Effect (Readable ())
|
||||
|
||||
-- | FFI binding to `import('pg-copy-streams').from`
|
||||
foreign import __execStreamStdin :: String -> Client -> Effect (Writable ())
|
||||
|
||||
@@ -7,8 +7,25 @@ import Control.Promise as Promise
|
||||
import Effect (Effect)
|
||||
import Effect.Aff (Aff)
|
||||
import Effect.Postgres.Client (Client)
|
||||
import Effect.Postgres.Error as E
|
||||
import Effect.Postgres.Error.Except as E.Except
|
||||
import Effect.Postgres.Pool (Pool)
|
||||
import Effect.Postgres.Pool as X
|
||||
import Effect.Postgres.Pool
|
||||
(Config
|
||||
, Pool
|
||||
, PoolConfigRaw
|
||||
, acquireE
|
||||
, clientCount
|
||||
, clientIdleCount
|
||||
, clientWaitingCount
|
||||
, connectE
|
||||
, destroy
|
||||
, errorE
|
||||
, make
|
||||
, release
|
||||
, releaseE
|
||||
, removeE
|
||||
) as X
|
||||
|
||||
-- | Acquires a client from the pool.
|
||||
-- |
|
||||
@@ -17,8 +34,8 @@ import Effect.Postgres.Pool as X
|
||||
-- | * If the pool is 'full' and all clients are currently checked out will wait in a FIFO queue until a client becomes available by it being released back to the pool.
|
||||
-- |
|
||||
-- | <https://node-postgres.com/apis/pool#poolconnect>
|
||||
connect :: Pool -> Aff Client
|
||||
connect = Promise.toAffE <<< __connect
|
||||
connect :: Pool -> E.Except Aff Client
|
||||
connect = E.Except.with E.Connecting <<< Promise.toAffE <<< __connect
|
||||
|
||||
-- | Drain the pool of all active clients, disconnect them,
|
||||
-- | and shut down any internal timers in the pool.
|
||||
@@ -27,8 +44,8 @@ connect = Promise.toAffE <<< __connect
|
||||
-- | your process is attempting to shut down cleanly.
|
||||
-- |
|
||||
-- | <https://node-postgres.com/apis/pool#poolend>
|
||||
end :: Pool -> Aff Unit
|
||||
end = Promise.toAffE <<< __end
|
||||
end :: Pool -> E.Except Aff Unit
|
||||
end = E.Except.with E.Disconnecting <<< Promise.toAffE <<< __end
|
||||
|
||||
-- | FFI binding to `Pool#end`
|
||||
foreign import __end :: Pool -> Effect (Promise Unit)
|
||||
|
||||
50
src/Effect.Postgres.Error.Common.purs
Normal file
50
src/Effect.Postgres.Error.Common.purs
Normal file
@@ -0,0 +1,50 @@
|
||||
module Effect.Postgres.Error.Common where
|
||||
|
||||
import Prelude
|
||||
|
||||
import Data.Array as Array
|
||||
import Data.Array.NonEmpty (NonEmptyArray)
|
||||
import Data.Foldable (fold)
|
||||
import Data.Generic.Rep (class Generic)
|
||||
import Data.Maybe (maybe)
|
||||
import Data.Newtype (wrap)
|
||||
import Data.Postgres.Query (Query)
|
||||
import Data.String as String
|
||||
import Effect.Exception as Effect
|
||||
import Foreign (MultipleErrors)
|
||||
|
||||
type E = NonEmptyArray Error
|
||||
|
||||
data Error
|
||||
= Deserializing Query MultipleErrors
|
||||
| Serializing MultipleErrors
|
||||
| Executing Query Effect.Error
|
||||
| Connecting Effect.Error
|
||||
| Disconnecting Effect.Error
|
||||
| Other Effect.Error
|
||||
|
||||
derive instance Generic Error _
|
||||
instance Show Error where
|
||||
show = toString
|
||||
|
||||
toString :: Error -> String
|
||||
toString =
|
||||
let
|
||||
indent n s = fold $ ((fold $ Array.replicate n " ") <> _) <$> String.split (wrap "\n") s
|
||||
jsError n e =
|
||||
indent n (Effect.message e)
|
||||
<> maybe "" (\s -> "\n" <> indent n s) (Effect.stack e)
|
||||
in
|
||||
case _ of
|
||||
Deserializing q es -> "Deserializing " <> show q <> "\n" <> indent 1 (show es)
|
||||
Serializing es -> "Serializing" <> "\n" <> indent 1 (show es)
|
||||
Executing q e -> "Executing " <> show q <> "\n" <> jsError 1 e
|
||||
Connecting e -> "Connecting\n" <> jsError 1 e
|
||||
Disconnecting e -> "Disconnecting\n" <> jsError 1 e
|
||||
Other e -> "Other\n" <> jsError 1 e
|
||||
|
||||
toException' :: Error -> Effect.Error
|
||||
toException' = Effect.error <<< show
|
||||
|
||||
toException :: E -> Effect.Error
|
||||
toException = Effect.error <<< show
|
||||
44
src/Effect.Postgres.Error.Except.purs
Normal file
44
src/Effect.Postgres.Error.Except.purs
Normal file
@@ -0,0 +1,44 @@
|
||||
module Effect.Postgres.Error.Except where
|
||||
|
||||
import Prelude
|
||||
|
||||
import Control.Monad.Error.Class (class MonadError, class MonadThrow, liftEither, try)
|
||||
import Control.Monad.Except (ExceptT(..), runExceptT)
|
||||
import Control.Monad.Morph (hoist)
|
||||
import Data.Bifunctor (lmap)
|
||||
import Data.Either (Either)
|
||||
import Data.Postgres (RepT)
|
||||
import Data.Postgres.Query (Query)
|
||||
import Effect.Class (class MonadEffect, liftEffect)
|
||||
import Effect.Exception as Effect
|
||||
import Effect.Postgres.Error.Common (E, Error(..), toException)
|
||||
|
||||
type Except m = ExceptT E m
|
||||
|
||||
run :: forall m a. MonadThrow Effect.Error m => Except m a -> m a
|
||||
run m = liftEither =<< lmap toException <$> runExceptT m
|
||||
|
||||
toEither :: forall m a. Except m a -> m (Either E a)
|
||||
toEither = runExceptT
|
||||
|
||||
with :: forall e m a. MonadError e m => (e -> Error) -> m a -> Except m a
|
||||
with e m = ExceptT $ map (lmap $ pure <<< e) $ try m
|
||||
|
||||
withEither :: forall e m a. Monad m => (e -> Error) -> m (Either e a) -> Except m a
|
||||
withEither e m = ExceptT $ map (lmap $ pure <<< e) $ m
|
||||
|
||||
exception :: forall m a. MonadError Effect.Error m => m a -> Except m a
|
||||
exception = with Other
|
||||
|
||||
executing :: forall m a. MonadError Effect.Error m => Query -> m a -> Except m a
|
||||
executing q = with (Executing q)
|
||||
|
||||
parsing :: forall m a. MonadEffect m => Query -> RepT a -> Except m a
|
||||
parsing q m = do
|
||||
e <- hoist liftEffect $ exception $ runExceptT m
|
||||
withEither (Deserializing q) (pure e)
|
||||
|
||||
printing :: forall m a. MonadEffect m => RepT a -> Except m a
|
||||
printing m = do
|
||||
e <- hoist liftEffect $ exception $ runExceptT m
|
||||
withEither Serializing (pure e)
|
||||
157
src/Effect.Postgres.Error.RE.purs
Normal file
157
src/Effect.Postgres.Error.RE.purs
Normal file
@@ -0,0 +1,157 @@
|
||||
module Effect.Postgres.Error.RE where
|
||||
|
||||
import Prelude hiding (join)
|
||||
|
||||
import Control.Alt (class Alt)
|
||||
import Control.Alternative (class Alternative, class Plus)
|
||||
import Control.Monad.Base (class MonadBase)
|
||||
import Control.Monad.Error.Class (class MonadError, class MonadThrow, catchError, liftEither, liftMaybe, throwError)
|
||||
import Control.Monad.Except (ExceptT, runExceptT)
|
||||
import Control.Monad.Fork.Class (class MonadBracket, class MonadFork, class MonadKill, bracket, fork, join, kill, never, suspend, uninterruptible)
|
||||
import Control.Monad.Fork.Class as Bracket
|
||||
import Control.Monad.Morph (class MFunctor, class MMonad, embed, hoist)
|
||||
import Control.Monad.Reader (class MonadAsk, class MonadReader, ReaderT(..), ask, runReaderT)
|
||||
import Control.Monad.Rec.Class (class MonadRec)
|
||||
import Control.Monad.Trans.Class (class MonadTrans, lift)
|
||||
import Control.Monad.Unlift (class MonadUnlift)
|
||||
import Control.Parallel (class Parallel, parallel, sequential)
|
||||
import Data.Array.NonEmpty as Array.NonEmpty
|
||||
import Data.Bifunctor (lmap)
|
||||
import Data.Either (Either, blush, hush)
|
||||
import Data.Functor.Compose (Compose(..))
|
||||
import Data.Maybe (Maybe(..), fromMaybe)
|
||||
import Data.Newtype (class Newtype, unwrap, wrap)
|
||||
import Data.Traversable (for_, traverse_)
|
||||
import Effect.Aff.Class (class MonadAff, liftAff)
|
||||
import Effect.Aff.Unlift (class MonadUnliftAff, withRunInAff)
|
||||
import Effect.Class (class MonadEffect, liftEffect)
|
||||
import Effect.Exception as Effect
|
||||
import Effect.Exception as Exception
|
||||
import Effect.Postgres.Error.Common (E, Error(..), toException)
|
||||
import Effect.Postgres.Error.Except (Except)
|
||||
import Effect.Postgres.Error.Except as E
|
||||
import Effect.Ref as Ref
|
||||
import Effect.Unlift (class MonadUnliftEffect, withRunInEffect)
|
||||
|
||||
-- | `ReaderT` with `ExceptT E`
|
||||
-- |
|
||||
-- | `ReaderT r (ExceptT (NonEmptyList Effect.Postgres.Error.Error) m) a`
|
||||
newtype RE r m a = RE (ReaderT r (ExceptT E m) a)
|
||||
|
||||
newtype ParRE r f a = ParRE (ReaderT r (Compose f (Either E)) a)
|
||||
|
||||
finally :: forall r m a. Monad m => RE r m Unit -> RE r m a -> RE r m a
|
||||
finally after m = (m <* after) `catchError` \e -> after *> throwError e
|
||||
|
||||
run :: forall m r a. MonadThrow Effect.Error m => RE r m a -> r -> m a
|
||||
run m r = liftEither =<< lmap toException <$> runExceptT (runReaderT (unwrap m) r)
|
||||
|
||||
toExcept :: forall m r a. RE r m a -> r -> Except m a
|
||||
toExcept m r = runReaderT (unwrap m) r
|
||||
|
||||
toEither :: forall m r a. RE r m a -> r -> m (Either E a)
|
||||
toEither m r = runExceptT $ runReaderT (unwrap m) r
|
||||
|
||||
liftExcept :: forall m r a. Monad m => Except m a -> RE r m a
|
||||
liftExcept = wrap <<< lift
|
||||
|
||||
derive instance Newtype (ParRE r m a) _
|
||||
derive newtype instance Functor m => Functor (ParRE r m)
|
||||
derive newtype instance Apply m => Apply (ParRE r m)
|
||||
derive newtype instance Applicative m => Applicative (ParRE r m)
|
||||
derive newtype instance Alt m => Alt (ParRE r m)
|
||||
derive newtype instance Plus m => Plus (ParRE r m)
|
||||
derive newtype instance Alternative m => Alternative (ParRE r m)
|
||||
|
||||
derive instance Newtype (RE r m a) _
|
||||
derive newtype instance Monad m => MonadAsk r (RE r m)
|
||||
derive newtype instance Monad m => MonadReader r (RE r m)
|
||||
derive newtype instance Monad m => Functor (RE r m)
|
||||
derive newtype instance Monad m => Apply (RE r m)
|
||||
derive newtype instance Monad m => Applicative (RE r m)
|
||||
derive newtype instance Monad m => Bind (RE r m)
|
||||
derive newtype instance Monad m => Monad (RE r m)
|
||||
derive newtype instance Monad m => MonadError E (RE r m)
|
||||
derive newtype instance Monad m => MonadThrow E (RE r m)
|
||||
derive newtype instance MonadRec m => MonadRec (RE r m)
|
||||
|
||||
instance MonadEffect m => MonadEffect (RE r m) where
|
||||
liftEffect m = hoist liftEffect $ liftExcept $ E.exception m
|
||||
|
||||
instance MonadAff m => MonadAff (RE r m) where
|
||||
liftAff m = hoist liftAff $ liftExcept $ E.exception m
|
||||
|
||||
instance (Monad m, Parallel p m) => Parallel (ParRE r p) (RE r m) where
|
||||
parallel = wrap <<< parallel <<< unwrap
|
||||
sequential = wrap <<< sequential <<< unwrap
|
||||
|
||||
instance MonadTrans (RE r) where
|
||||
lift = wrap <<< lift <<< lift
|
||||
|
||||
instance MFunctor (RE r) where
|
||||
hoist mn (RE m) = RE $ hoist (hoist mn) m
|
||||
|
||||
instance MMonad (RE r) where
|
||||
embed :: forall n m b. Monad n => (forall a. m a -> RE r n a) -> RE r m b -> RE r n b
|
||||
embed mtn (RE m) =
|
||||
RE $ ReaderT $ \r -> embed (flip runReaderT r <<< unwrap <<< mtn) (runReaderT m r)
|
||||
|
||||
instance Monad m => Alt (RE r m) where
|
||||
alt a b = catchError b (\e -> catchError a (\e' -> throwError $ e <> e'))
|
||||
|
||||
instance (MonadThrow Effect.Error m, MonadUnliftEffect m) => MonadUnliftEffect (RE r m) where
|
||||
withRunInEffect f = RE $ ReaderT $ \r -> lift $ withRunInEffect @m $ \a -> f (a <<< flip run r)
|
||||
|
||||
instance (MonadThrow Effect.Error m, MonadUnliftAff m) => MonadUnliftAff (RE r m) where
|
||||
withRunInAff f = RE $ ReaderT $ \r -> lift $ withRunInAff @m $ \a -> f (a <<< flip run r)
|
||||
|
||||
instance (MonadBase m (RE r m), MonadThrow Effect.Error m) => MonadUnlift m (RE r m) where
|
||||
withRunInBase f = RE $ ReaderT $ \r -> lift $ f (flip run r)
|
||||
|
||||
instance Monad m => MonadBase m (RE r m) where
|
||||
liftBase = lift
|
||||
|
||||
instance (MonadThrow Effect.Error m, MonadFork f m) => MonadFork (Compose f (Either E)) (RE r m) where
|
||||
fork m = RE $ ReaderT \r -> lift $ Compose <$> fork (toEither m r)
|
||||
suspend m = RE $ ReaderT \r -> lift $ Compose <$> suspend (toEither m r)
|
||||
join f = liftEither =<< lift (join $ unwrap f)
|
||||
|
||||
instance (MonadKill Effect.Error f m) => MonadKill E (Compose f (Either E)) (RE r m) where
|
||||
kill e f = lift $ kill (toException e) (unwrap f)
|
||||
|
||||
instance (MonadEffect m, MonadBracket Effect.Error f m) => MonadBracket E (Compose f (Either E)) (RE r m) where
|
||||
bracket acq rel go = do
|
||||
r <- ask
|
||||
|
||||
errs <- liftEffect $ Ref.new []
|
||||
|
||||
let
|
||||
eErrsEmpty = pure $ Other $ Exception.error "no errors"
|
||||
appendErrs = liftEffect <<< flip Ref.modify_ errs <<< (<>) <<< Array.NonEmpty.toArray
|
||||
readErrs = liftEffect $ Array.NonEmpty.fromArray <$> Ref.read errs
|
||||
|
||||
run' :: forall a. RE r m a -> m (Maybe a)
|
||||
run' m = do
|
||||
either <- toEither m r
|
||||
traverse_ appendErrs $ blush either
|
||||
pure $ hush either
|
||||
|
||||
rel' _ Nothing = pure unit
|
||||
rel' (Bracket.Failed e) (Just a) = void $ run' $ rel (Bracket.Failed $ pure $ Other e) a
|
||||
rel' (Bracket.Killed e) (Just a) = void $ run' $ rel (Bracket.Killed $ pure $ Other e) a
|
||||
rel' (Bracket.Completed (Just ret)) (Just a) = void $ run' $ rel (Bracket.Completed ret) a
|
||||
rel' (Bracket.Completed Nothing) (Just a) = void $ run' do
|
||||
errs' <- fromMaybe eErrsEmpty <$> readErrs
|
||||
rel (Bracket.Failed errs') a
|
||||
|
||||
acq' = run' acq
|
||||
|
||||
go' (Just a) = run' $ go a
|
||||
go' Nothing = pure Nothing
|
||||
|
||||
ret <- lift $ bracket acq' rel' go'
|
||||
errs' <- readErrs
|
||||
for_ errs' throwError
|
||||
liftMaybe eErrsEmpty ret
|
||||
uninterruptible = hoist uninterruptible
|
||||
never = lift never
|
||||
5
src/Effect.Postgres.Error.purs
Normal file
5
src/Effect.Postgres.Error.purs
Normal file
@@ -0,0 +1,5 @@
|
||||
module Effect.Postgres.Error (module X) where
|
||||
|
||||
import Effect.Postgres.Error.Common as X
|
||||
import Effect.Postgres.Error.RE (RE(..), ParRE(..)) as X
|
||||
import Effect.Postgres.Error.Except (Except) as X
|
||||
@@ -9,6 +9,8 @@ import Effect (Effect)
|
||||
import Effect.Exception (Error)
|
||||
import Effect.Postgres.Client (Client)
|
||||
import Effect.Postgres.Client as Client
|
||||
import Effect.Postgres.Error as E
|
||||
import Effect.Postgres.Error.Except as E.Except
|
||||
import Effect.Uncurried (EffectFn2, mkEffectFn1, mkEffectFn2)
|
||||
import Foreign (Foreign, unsafeToForeign)
|
||||
import Node.EventEmitter (EventHandle(..))
|
||||
@@ -46,12 +48,12 @@ make r = do
|
||||
__make $ __uncfg { unwrapMillis: unwrap } $ unsafeToForeign asClientConfig
|
||||
|
||||
-- | <https://node-postgres.com/apis/pool#releasing-clients>
|
||||
release :: Pool -> Client -> Effect Unit
|
||||
release p c = __release p c false
|
||||
release :: Pool -> Client -> E.Except Effect Unit
|
||||
release p c = E.Except.with E.Disconnecting $ __release p c false
|
||||
|
||||
-- | <https://node-postgres.com/apis/pool#releasing-clients>
|
||||
destroy :: Pool -> Client -> Effect Unit
|
||||
destroy p c = __release p c true
|
||||
destroy :: Pool -> Client -> E.Except Effect Unit
|
||||
destroy p c = E.Except.with E.Disconnecting $ __release p c true
|
||||
|
||||
-- | <https://node-postgres.com/apis/pool#connect>
|
||||
connectE :: EventHandle1 Pool Client
|
||||
|
||||
10
src/Node.FS.PinnedVersion.purs
Normal file
10
src/Node.FS.PinnedVersion.purs
Normal file
@@ -0,0 +1,10 @@
|
||||
module Node.FS.PinnedVersion where
|
||||
|
||||
import Prelude
|
||||
|
||||
import Effect.Aff (Aff)
|
||||
import Node.Encoding (Encoding(..))
|
||||
import Node.FS.Aff as FS
|
||||
|
||||
foo :: Aff Unit
|
||||
foo = FS.writeTextFile UTF8 "foo" "foo"
|
||||
29
src/Pipes.Postgres.purs
Normal file
29
src/Pipes.Postgres.purs
Normal file
@@ -0,0 +1,29 @@
|
||||
module Pipes.Postgres where
|
||||
|
||||
import Prelude
|
||||
|
||||
import Control.Monad.Cont (lift)
|
||||
import Control.Monad.Morph (hoist)
|
||||
import Control.Monad.Postgres (SessionT)
|
||||
import Control.Monad.Reader (ask)
|
||||
import Data.Maybe (Maybe)
|
||||
import Effect.Aff.Class (class MonadAff, liftAff)
|
||||
import Effect.Aff.Postgres.Client as Client
|
||||
import Effect.Class (liftEffect)
|
||||
import Effect.Postgres.Error.RE as RE
|
||||
import Node.Buffer (Buffer)
|
||||
import Node.Stream.Object as Node.Stream.Object
|
||||
import Pipes.Core (Consumer, Producer)
|
||||
import Pipes.Node.Stream as Pipe.Node
|
||||
|
||||
stdin :: forall m. MonadAff m => String -> Consumer (Maybe Buffer) (SessionT m) Unit
|
||||
stdin q = do
|
||||
client <- lift ask
|
||||
stream <- lift $ RE.liftExcept $ hoist liftEffect $ Client.execWithStdin q client
|
||||
hoist liftAff $ Pipe.Node.fromWritable $ Node.Stream.Object.unsafeFromBufferWritable stream
|
||||
|
||||
stdout :: forall m. MonadAff m => String -> Producer (Maybe Buffer) (SessionT m) Unit
|
||||
stdout q = do
|
||||
client <- lift ask
|
||||
stream <- lift $ RE.liftExcept $ hoist liftEffect $ Client.queryWithStdout q client
|
||||
hoist liftAff $ Pipe.Node.fromReadable $ Node.Stream.Object.unsafeFromBufferReadable stream
|
||||
@@ -5,7 +5,7 @@ import Prelude
|
||||
import Data.Either (Either(..))
|
||||
import Data.String.Regex (Regex)
|
||||
import Data.String.Regex as Regex
|
||||
import Data.String.Regex.Flags (RegexFlags(..))
|
||||
import Data.String.Regex.Flags (RegexFlags)
|
||||
import Data.Tuple.Nested (type (/\), (/\))
|
||||
import Effect (Effect)
|
||||
import Effect.Aff (Aff, bracket, makeAff)
|
||||
@@ -14,14 +14,13 @@ import Effect.Aff.Postgres.Client as Client
|
||||
import Effect.Aff.Postgres.Pool (Pool)
|
||||
import Effect.Aff.Postgres.Pool as Pool
|
||||
import Effect.Class (liftEffect)
|
||||
import Effect.Postgres.Error.Except as X
|
||||
import Effect.Unsafe (unsafePerformEffect)
|
||||
import Node.EventEmitter (EventHandle(..))
|
||||
import Node.EventEmitter (EventHandle)
|
||||
import Node.EventEmitter as EE
|
||||
import Node.Path as Path
|
||||
import Node.Process (cwd)
|
||||
import Partial.Unsafe (unsafePartial)
|
||||
import Record (insert)
|
||||
import Type.Prelude (Proxy(..))
|
||||
|
||||
type Config =
|
||||
{ database :: String
|
||||
@@ -41,16 +40,16 @@ withConfig :: (Config -> Aff Unit) -> Aff Unit
|
||||
withConfig f = f =<< liftEffect config
|
||||
|
||||
withClient :: (Client -> Aff Unit) -> Aff Unit
|
||||
withClient = bracket (Client.connected =<< liftEffect config) Client.end
|
||||
withClient = bracket (X.run $ Client.connected =<< liftEffect config) (X.run <<< Client.end)
|
||||
|
||||
pool :: Pool
|
||||
pool = unsafePerformEffect $ Pool.make =<< liftEffect config
|
||||
|
||||
withPool :: (Pool -> Aff Unit) -> Aff Unit
|
||||
withPool = bracket (liftEffect $ Pool.make =<< config) Pool.end
|
||||
withPool = bracket (liftEffect $ Pool.make =<< config) (X.run <<< Pool.end)
|
||||
|
||||
withPoolClient :: (Client -> Aff Unit) -> Aff Unit
|
||||
withPoolClient = bracket (Pool.connect pool) (liftEffect <<< Pool.release pool)
|
||||
withPoolClient = bracket (X.run $ Pool.connect pool) (liftEffect <<< X.run <<< Pool.release pool)
|
||||
|
||||
unsafeFromRight :: forall a b. Either a b -> b
|
||||
unsafeFromRight e = unsafePartial $ case e of Right b -> b
|
||||
|
||||
@@ -2,23 +2,32 @@ module Test.Control.Monad.Postgres where
|
||||
|
||||
import Prelude
|
||||
|
||||
import Control.Monad.Error.Class (throwError)
|
||||
import Control.Monad.Cont (lift)
|
||||
import Control.Monad.Error.Class (catchError, throwError, try)
|
||||
import Control.Monad.Fork.Class (class MonadBracket, bracket)
|
||||
import Control.Monad.Postgres (PostgresT, exec_, query, runPostgres, session, transaction, cursor, fetch, fetchAll, fetchOne)
|
||||
import Control.Parallel (parTraverse_)
|
||||
import Control.Monad.Postgres (PostgresT, cursor, exec_, fetch, fetchAll, fetchOne, query, runPostgres, transaction)
|
||||
import Control.Monad.Reader (ask)
|
||||
import Control.Parallel (parTraverse)
|
||||
import Data.Array as Array
|
||||
import Data.Array.NonEmpty as Array.NonEmpty
|
||||
import Data.Maybe (Maybe(..), fromJust, maybe)
|
||||
import Data.String.Regex as Regex
|
||||
import Data.String.Regex.Flags as Regex.Flag
|
||||
import Data.Traversable (for_)
|
||||
import Data.Tuple.Nested ((/\))
|
||||
import Effect.Aff (Fiber)
|
||||
import Effect.Aff.Class (class MonadAff)
|
||||
import Effect.Aff.Class (class MonadAff, liftAff)
|
||||
import Effect.Aff.Unlift (UnliftAff(..), askUnliftAff)
|
||||
import Effect.Class (liftEffect)
|
||||
import Effect.Console (log)
|
||||
import Effect.Exception (Error, error)
|
||||
import Effect.Postgres.Error as E
|
||||
import Effect.Postgres.Error.Except as X
|
||||
import Effect.Postgres.Error.RE as RE
|
||||
import Partial.Unsafe (unsafePartial)
|
||||
import Test.Common (re, withConfig)
|
||||
import Test.Spec (Spec, around, describe, it)
|
||||
import Test.Spec.Assertions (expectError, shouldEqual)
|
||||
import Test.Spec.Assertions (shouldEqual)
|
||||
|
||||
withTable :: forall a m. MonadBracket Error Fiber m => MonadAff m => String -> PostgresT m a -> PostgresT m a
|
||||
withTable s m =
|
||||
@@ -30,30 +39,41 @@ withTable s m =
|
||||
spec :: Spec Unit
|
||||
spec =
|
||||
around withConfig $ describe "Control.Monad.Postgres" do
|
||||
it "empty works" \cfg -> runPostgres cfg $ pure unit
|
||||
it "connects" \cfg -> runPostgres cfg $ shouldEqual 1 =<< query "select 1"
|
||||
it "multiple sessions serially" \cfg -> runPostgres cfg do
|
||||
shouldEqual 1 =<< query "select 1"
|
||||
shouldEqual 2 =<< query "select 2"
|
||||
it "multiple sessions concurrently" \cfg -> runPostgres cfg do
|
||||
flip parTraverse_ [ 1, 2, 3 ] \_ -> shouldEqual 1 =<< query "select 1"
|
||||
it "transaction commits" \cfg -> runPostgres cfg do
|
||||
exec_ "create temporary table test_txn_commits (id int);"
|
||||
transaction $ exec_ "insert into test_txn_commits values (1);"
|
||||
shouldEqual [ 1 ] =<< query "select * from test_txn_commits"
|
||||
it "transaction rolls back" \cfg -> runPostgres cfg do
|
||||
exec_ "create temporary table test_txn_rolls_back (id int);"
|
||||
exec_ "insert into test_txn_rolls_back values (1);"
|
||||
expectError $ transaction do
|
||||
exec_ "insert into test_txn_rolls_back values (2);"
|
||||
throwError $ error "foo"
|
||||
shouldEqual [ 1 ] =<< query "select * from test_txn_rolls_back"
|
||||
it "cursor" \cfg -> runPostgres cfg do
|
||||
exec_ $ "create temporary table test_cursor_data (id int primary key generated always as identity)"
|
||||
for_ (Array.range 1 50) $ const $ exec_ "insert into test_cursor_data (id) values (default);"
|
||||
cursor @Int "test_cursor" "select id from test_cursor_data" do
|
||||
shouldEqual (Just 1) =<< fetchOne
|
||||
shouldEqual (Just 2) =<< fetchOne
|
||||
shouldEqual (Just 3) =<< fetchOne
|
||||
shouldEqual [ 4, 5, 6, 7, 8 ] =<< fetch 5
|
||||
shouldEqual (Array.range 9 50) =<< fetchAll
|
||||
it "empty works" \cfg -> X.run $ runPostgres cfg $ pure unit
|
||||
it "connects" \cfg -> shouldEqual 1 =<< X.run (runPostgres cfg $ query "select 1")
|
||||
it "multiple sessions serially" \cfg -> do
|
||||
a /\ b <- X.run $ runPostgres cfg do
|
||||
a <- query "select 1"
|
||||
b <- query "select 2"
|
||||
pure $ a /\ b
|
||||
a `shouldEqual` 1
|
||||
b `shouldEqual` 2
|
||||
it "multiple sessions concurrently" \cfg -> do
|
||||
nums <- X.run $ runPostgres cfg $ parTraverse (\n -> query $ "select $1 :: int" /\ n) (Array.range 1 3)
|
||||
Array.sort nums `shouldEqual` [1, 2, 3]
|
||||
it "transaction commits" \cfg -> do
|
||||
a <- X.run $ runPostgres cfg do
|
||||
exec_ "create temporary table test_txn_commits (id int);"
|
||||
transaction $ exec_ "insert into test_txn_commits values (1);"
|
||||
query "select * from test_txn_commits"
|
||||
a `shouldEqual` [ 1 ]
|
||||
it "transaction rolls back" \cfg -> do
|
||||
a <- X.run $ runPostgres cfg do
|
||||
exec_ "create temporary table test_txn_rolls_back (id int);"
|
||||
exec_ "insert into test_txn_rolls_back values (1);"
|
||||
void $ try $ transaction do
|
||||
exec_ "insert into test_txn_rolls_back values (2);"
|
||||
throwError $ pure $ E.Other $ error "foo"
|
||||
query "select * from test_txn_rolls_back"
|
||||
a `shouldEqual` [1]
|
||||
it "cursor" \cfg ->
|
||||
X.run $ runPostgres cfg do
|
||||
exec_ $ "create temporary table test_cursor_data (id int primary key generated always as identity)"
|
||||
for_ (Array.range 1 50) $ const $ exec_ "insert into test_cursor_data (id) values (default);"
|
||||
cursor @Int "test_cursor" "select id from test_cursor_data" do
|
||||
UnliftAff unliftAff <- askUnliftAff
|
||||
liftAff $ shouldEqual (Just 1) =<< unliftAff fetchOne
|
||||
liftAff $ shouldEqual (Just 2) =<< unliftAff fetchOne
|
||||
liftAff $ shouldEqual (Just 3) =<< unliftAff fetchOne
|
||||
liftAff $ shouldEqual [ 4, 5, 6, 7, 8 ] =<< unliftAff (fetch 5)
|
||||
liftAff $ shouldEqual (Array.range 9 50) =<< unliftAff fetchAll
|
||||
|
||||
37
test/Test.Data.Postgres.Interval.purs
Normal file
37
test/Test.Data.Postgres.Interval.purs
Normal file
@@ -0,0 +1,37 @@
|
||||
module Test.Data.Postgres.Interval where
|
||||
|
||||
import Prelude
|
||||
|
||||
import Data.Postgres.Interval as Interval
|
||||
import Data.Time.Duration (Milliseconds(..))
|
||||
import Data.Traversable (for_)
|
||||
import Data.Tuple.Nested (type (/\), (/\))
|
||||
import Effect.Class (liftEffect)
|
||||
import Test.Spec (Spec, describe, it)
|
||||
import Test.Spec.Assertions (shouldEqual)
|
||||
|
||||
spec :: Spec Unit
|
||||
spec =
|
||||
describe "Data.Postgres.Interval" do
|
||||
it "parse & toRecord" do
|
||||
p <- liftEffect $ Interval.parse "3 days 04:05:06"
|
||||
Interval.toRecord p `shouldEqual` Interval.zero {days = 3, hours = 4, minutes = 5, seconds = 6}
|
||||
|
||||
it "make & toRecord" do
|
||||
let p = Interval.make $ Interval.zero {days = 3, hours = 4, minutes = 5, seconds = 6}
|
||||
Interval.toRecord p `shouldEqual` Interval.zero {days = 3, hours = 4, minutes = 5, seconds = 6}
|
||||
|
||||
describe "fromDuration" do
|
||||
for_
|
||||
[ Milliseconds 100.0 /\ Interval.zero {milliseconds = 100.0}
|
||||
, Milliseconds 1000.0 /\ Interval.zero {seconds = 1}
|
||||
, Milliseconds 1100.0 /\ Interval.zero {seconds = 1, milliseconds = 100.0}
|
||||
, Milliseconds 60000.0 /\ Interval.zero {minutes = 1}
|
||||
, Milliseconds 61100.0 /\ Interval.zero {minutes = 1, seconds = 1, milliseconds = 100.0}
|
||||
, Milliseconds 3600000.0 /\ Interval.zero {hours = 1}
|
||||
, Milliseconds 3661100.0 /\ Interval.zero {hours = 1, minutes = 1, seconds = 1, milliseconds = 100.0}
|
||||
, Milliseconds 86400000.0 /\ Interval.zero {days = 1}
|
||||
, Milliseconds 90061100.0 /\ Interval.zero {days = 1, hours = 1, minutes = 1, seconds = 1, milliseconds = 100.0}
|
||||
]
|
||||
\(i /\ o) -> it ("converts " <> show i) do
|
||||
Interval.toRecord (Interval.fromDuration i) `shouldEqual` o
|
||||
@@ -2,28 +2,28 @@ module Test.Data.Postgres where
|
||||
|
||||
import Prelude
|
||||
|
||||
import Control.Monad.Gen (chooseInt, elements, oneOf)
|
||||
import Control.Monad.Gen (chooseFloat, chooseInt, elements, oneOf)
|
||||
import Control.Parallel (parTraverse_)
|
||||
import Data.Array (intercalate)
|
||||
import Data.Array as Array
|
||||
import Data.Array.NonEmpty as Array.NonEmpty
|
||||
import Data.DateTime (DateTime(..), canonicalDate)
|
||||
import Data.DateTime.Instant as Instant
|
||||
import Data.Enum (toEnum)
|
||||
import Data.Foldable (fold)
|
||||
import Data.Identity (Identity)
|
||||
import Data.Int as Int
|
||||
import Data.Maybe (Maybe(..), fromJust, maybe)
|
||||
import Data.Maybe (Maybe(..), fromJust, fromMaybe)
|
||||
import Data.Newtype (class Newtype, unwrap, wrap)
|
||||
import Data.Number (abs) as Number
|
||||
import Data.Postgres (class Rep)
|
||||
import Data.Postgres.Interval (Interval)
|
||||
import Data.Postgres.Interval as Interval
|
||||
import Data.Postgres.Query.Builder as Q
|
||||
import Data.Postgres.Raw (Raw, jsNull)
|
||||
import Data.Postgres.Raw as Raw
|
||||
import Data.Postgres.Result (class FromRow)
|
||||
import Data.RFC3339String as DateTime.ISO
|
||||
import Data.String as String
|
||||
import Data.Time (Time(..))
|
||||
import Data.Time.Duration (class Duration, Days, Hours, Milliseconds, Minutes, Seconds)
|
||||
import Data.Traversable (for, sequence)
|
||||
import Data.Tuple.Nested ((/\))
|
||||
import Effect (Effect)
|
||||
@@ -31,24 +31,50 @@ import Effect.Aff (Aff)
|
||||
import Effect.Aff.Postgres.Client (exec, query)
|
||||
import Effect.Class (liftEffect)
|
||||
import Effect.Postgres.Client (Client)
|
||||
import Effect.Postgres.Error.Except as X
|
||||
import Effect.Unsafe (unsafePerformEffect)
|
||||
import Foreign (Foreign, unsafeToForeign)
|
||||
import Foreign.Object as Object
|
||||
import JS.BigInt (BigInt)
|
||||
import JS.BigInt as BigInt
|
||||
import Node.Buffer (Buffer)
|
||||
import Node.Buffer as Buffer
|
||||
import Partial.Unsafe (unsafePartial)
|
||||
import Simple.JSON (writeJSON)
|
||||
import Test.Common (withClient, withPoolClient)
|
||||
import Test.Common (withPoolClient)
|
||||
import Test.QuickCheck (class Arbitrary, arbitrary, randomSeed)
|
||||
import Test.QuickCheck.Gen (sample, vectorOf)
|
||||
import Test.Spec (Spec, SpecT, around, describe, it, parallel)
|
||||
import Test.Spec (Spec, SpecT, around, describe, it)
|
||||
import Test.Spec.Assertions (fail)
|
||||
|
||||
foreign import readBigInt64BE :: Buffer -> Effect BigInt
|
||||
foreign import dbg :: forall a. a -> Effect Unit
|
||||
|
||||
newtype GenIntervalSubMonth = GenIntervalSubMonth Interval
|
||||
|
||||
derive instance Newtype GenIntervalSubMonth _
|
||||
instance Arbitrary GenIntervalSubMonth where
|
||||
arbitrary = do
|
||||
days <- chooseInt 0 30
|
||||
hours <- chooseInt 0 23
|
||||
minutes <- chooseInt 0 59
|
||||
seconds <- chooseInt 0 59
|
||||
milliseconds <- chooseFloat 0.0 999.9
|
||||
pure $ wrap $ Interval.make $ Interval.zero {days = days, hours = hours, minutes = minutes, seconds = seconds, milliseconds = milliseconds}
|
||||
|
||||
newtype GenInterval = GenInterval Interval
|
||||
|
||||
derive instance Newtype GenInterval _
|
||||
instance Arbitrary GenInterval where
|
||||
arbitrary = do
|
||||
years <- chooseInt 0 10
|
||||
months <- chooseInt 0 11
|
||||
days <- chooseInt 0 30
|
||||
hours <- chooseInt 0 23
|
||||
minutes <- chooseInt 0 59
|
||||
seconds <- chooseInt 0 59
|
||||
milliseconds <- chooseFloat 0.0 999.9
|
||||
pure $ wrap $ Interval.make {years, months, days, hours, minutes, seconds, milliseconds}
|
||||
|
||||
newtype GenSmallInt = GenSmallInt Int
|
||||
|
||||
derive instance Newtype GenSmallInt _
|
||||
@@ -181,13 +207,13 @@ spec =
|
||||
x' <- Q.param $ fromArb x
|
||||
let val = x' <> " :: " <> sql
|
||||
pure $ "select " <> val
|
||||
void $ exec createtab c
|
||||
void $ X.run $ exec createtab c
|
||||
seed <- liftEffect randomSeed
|
||||
let xs = sample seed 10 (arbitrary @x)
|
||||
flip parTraverse_ xs
|
||||
\x -> do
|
||||
void $ exec (ser x) c
|
||||
res <- query (de x) c
|
||||
void $ X.run $ exec (ser x) c
|
||||
res <- X.run $ query (de x) c
|
||||
let
|
||||
exp = fromArb x
|
||||
act = unsafePartial fromJust $ Array.head res
|
||||
@@ -196,6 +222,17 @@ spec =
|
||||
around withPoolClient
|
||||
$ describe "Data.Postgres"
|
||||
$ do
|
||||
let
|
||||
durationFromGenInterval :: forall d. Semigroup d => Duration d => Newtype d Number => GenIntervalSubMonth -> d
|
||||
durationFromGenInterval = fromMaybe (wrap 0.0) <<< Interval.toDuration <<< unwrap
|
||||
durationEq :: forall d. Duration d => Newtype d Number => d -> d -> Boolean
|
||||
durationEq a b = Number.abs (unwrap a - unwrap b) <= 0.001
|
||||
check @Milliseconds @GenIntervalSubMonth { purs: "Milliseconds", sql: "interval", fromArb: durationFromGenInterval, isEq: durationEq}
|
||||
check @Seconds @GenIntervalSubMonth { purs: "Seconds", sql: "interval", fromArb: durationFromGenInterval, isEq: durationEq}
|
||||
check @Minutes @GenIntervalSubMonth { purs: "Minutes", sql: "interval", fromArb: durationFromGenInterval, isEq: durationEq}
|
||||
check @Hours @GenIntervalSubMonth { purs: "Hours", sql: "interval", fromArb: durationFromGenInterval, isEq: durationEq}
|
||||
check @Days @GenIntervalSubMonth { purs: "Days", sql: "interval", fromArb: durationFromGenInterval, isEq: durationEq}
|
||||
|
||||
check @Int @GenSmallInt { purs: "Int", sql: "int2", fromArb: unwrap, isEq: eq }
|
||||
check @Int { purs: "Int", sql: "int4", fromArb: identity, isEq: eq }
|
||||
check @String @GenString { purs: "String", sql: "text", fromArb: unwrap, isEq: eq }
|
||||
|
||||
@@ -12,6 +12,7 @@ import Effect.Aff (forkAff, joinFiber)
|
||||
import Effect.Aff.Postgres.Client (query)
|
||||
import Effect.Aff.Postgres.Client as Client
|
||||
import Effect.Exception as Error
|
||||
import Effect.Postgres.Error.Except as X
|
||||
import Test.Common (onceAff, withClient)
|
||||
import Test.Spec (Spec, around, describe, it)
|
||||
import Test.Spec.Assertions (shouldEqual)
|
||||
@@ -23,40 +24,40 @@ spec =
|
||||
describe "events" do
|
||||
it "end" \c -> do
|
||||
expect <- forkAff $ onceAff Client.endE c
|
||||
Client.end c
|
||||
X.run $ Client.end c
|
||||
joinFiber expect
|
||||
it "notice" \c -> do
|
||||
expect <- forkAff do
|
||||
e <- onceAff Client.noticeE c
|
||||
Error.message e `shouldEqual` "hello"
|
||||
void $ Client.exec "do language plpgsql $$ begin raise notice 'hello'; end; $$;" c
|
||||
X.run $ void $ Client.exec "do language plpgsql $$ begin raise notice 'hello'; end; $$;" c
|
||||
joinFiber expect
|
||||
it "notification" \c -> do
|
||||
void $ Client.exec "listen hello;" c
|
||||
X.run $ void $ Client.exec "listen hello;" c
|
||||
expect <- forkAff do
|
||||
n <- onceAff Client.notificationE c
|
||||
n.payload `shouldEqual` (Just "world")
|
||||
void $ Client.exec "notify hello, 'world';" c
|
||||
X.run $ void $ Client.exec "notify hello, 'world';" c
|
||||
joinFiber expect
|
||||
it "connect & end do not throw" $ const $ pure unit
|
||||
describe "query" do
|
||||
it "ok if connected" \c -> shouldEqual [ 1, 2, 3 ] =<< query "select unnest(array[1, 2, 3])" c
|
||||
it "ok if connected" \c -> shouldEqual [ 1, 2, 3 ] =<< X.run (query "select unnest(array[1, 2, 3])" c)
|
||||
it "throws if ended" \c -> do
|
||||
Client.end c
|
||||
res :: Either _ (Array Int) <- try $ query "select 1" c
|
||||
X.run $ Client.end c
|
||||
res :: Either _ (Array Int) <- try $ X.run $ query "select 1" c
|
||||
isLeft res `shouldEqual` true
|
||||
it "rowsAffected is correct" \c -> do
|
||||
void $ Client.exec "create temp table foo (bar int);" c
|
||||
shouldEqual 1 =<< Client.exec "insert into foo values (1);" c
|
||||
shouldEqual 3 =<< Client.exec "insert into foo values (1), (2), (3);" c
|
||||
shouldEqual 4 =<< Client.exec "update foo set bar = 10;" c
|
||||
X.run $ void $ Client.exec "create temp table foo (bar int);" c
|
||||
shouldEqual 1 =<< X.run (Client.exec "insert into foo values (1);" c)
|
||||
shouldEqual 3 =<< X.run (Client.exec "insert into foo values (1), (2), (3);" c)
|
||||
shouldEqual 4 =<< X.run (Client.exec "update foo set bar = 10;" c)
|
||||
describe "timestamp" do
|
||||
it "unmarshals" \c -> do
|
||||
let exp = toDateTimeLossy <$> fromRFC3339String (wrap "2020-01-01T00:00:00Z")
|
||||
shouldEqual exp =<< query "select '2020-01-01T00:00:00Z' :: timestamptz" c
|
||||
it "is string" \c -> shouldEqual "2020-01-01 00:00:00+00" =<< query "select '2020-01-01T00:00:00Z' :: timestamptz" c
|
||||
it "array is string" \c -> shouldEqual [ [ "2020-01-01 00:00:00+00" ] ] =<< query "select array['2020-01-01T00:00:00Z' :: timestamptz]" c
|
||||
shouldEqual exp =<< X.run (query "select '2020-01-01T00:00:00Z' :: timestamptz" c)
|
||||
it "is string" \c -> shouldEqual "2020-01-01 00:00:00+00" =<< X.run (query "select '2020-01-01T00:00:00Z' :: timestamptz" c)
|
||||
it "array is string" \c -> shouldEqual [ [ "2020-01-01 00:00:00+00" ] ] =<< X.run (query "select array['2020-01-01T00:00:00Z' :: timestamptz]" c)
|
||||
describe "json" do
|
||||
it "unmarshals" \c -> shouldEqual (JSON { foo: "bar" }) =<< query "select '{\"foo\": \"bar\"}' :: json" c
|
||||
it "is string" \c -> shouldEqual "{\"foo\": \"bar\"}" =<< query "select '{\"foo\": \"bar\"}' :: json" c
|
||||
it "array is string" \c -> shouldEqual [ [ "{\"foo\": \"bar\"}" ] ] =<< query "select array['{\"foo\": \"bar\"}' :: json]" c
|
||||
it "unmarshals" \c -> shouldEqual (JSON { foo: "bar" }) =<< X.run (query "select '{\"foo\": \"bar\"}' :: json" c)
|
||||
it "is string" \c -> shouldEqual "{\"foo\": \"bar\"}" =<< X.run (query "select '{\"foo\": \"bar\"}' :: json" c)
|
||||
it "array is string" \c -> shouldEqual [ [ "{\"foo\": \"bar\"}" ] ] =<< X.run (query "select array['{\"foo\": \"bar\"}' :: json]" c)
|
||||
|
||||
135
test/Test.Effect.Postgres.Error.purs
Normal file
135
test/Test.Effect.Postgres.Error.purs
Normal file
@@ -0,0 +1,135 @@
|
||||
module Test.Effect.Postgres.Error where
|
||||
|
||||
import Prelude hiding (join)
|
||||
|
||||
import Control.Monad.Cont (lift)
|
||||
import Control.Monad.Error.Class (throwError)
|
||||
import Control.Monad.Fork.Class (bracket, fork, join)
|
||||
import Control.Parallel (parOneOf, parSequence)
|
||||
import Data.Either (isLeft)
|
||||
import Data.Newtype (wrap)
|
||||
import Data.Postgres (deserialize)
|
||||
import Data.Postgres.Query (stringQuery)
|
||||
import Data.Postgres.Raw (Raw)
|
||||
import Effect.Aff (Aff, delay)
|
||||
import Effect.Aff.Class (liftAff)
|
||||
import Effect.Class (liftEffect)
|
||||
import Effect.Exception as Exn
|
||||
import Effect.Postgres.Error (Error(..))
|
||||
import Effect.Postgres.Error.Except as E
|
||||
import Effect.Postgres.Error.RE (RE)
|
||||
import Effect.Postgres.Error.RE as RE
|
||||
import Test.Common (withPoolClient)
|
||||
import Test.Spec (Spec, around, describe, it)
|
||||
import Test.Spec.Assertions (shouldEqual)
|
||||
import Unsafe.Coerce (unsafeCoerce)
|
||||
|
||||
spec :: Spec Unit
|
||||
spec =
|
||||
around withPoolClient $ describe "Effect.Postgres.Error" do
|
||||
describe "Except" do
|
||||
it "catches Aff" $ const do
|
||||
either <- E.toEither $ E.exception (throwError $ Exn.error "foo")
|
||||
isLeft either `shouldEqual` true
|
||||
it "catches Effect" $ const do
|
||||
either <- liftEffect $ E.toEither $ E.exception (throwError $ Exn.error "foo")
|
||||
isLeft either `shouldEqual` true
|
||||
it "catches RepT" $ const do
|
||||
let
|
||||
parse = deserialize @Int (unsafeCoerce "foo" :: Raw)
|
||||
either <- liftEffect $ E.toEither $ E.parsing (stringQuery "select 'foo'") parse
|
||||
isLeft either `shouldEqual` true
|
||||
it "catches Effect exception in RepT" $ const do
|
||||
let
|
||||
parse = lift $ throwError $ Exn.error "foo"
|
||||
either <- liftEffect $ E.toEither $ E.parsing (stringQuery "select 'foo'") parse
|
||||
isLeft either `shouldEqual` true
|
||||
describe "RE" do
|
||||
it "liftAff catches exceptions" $ const do
|
||||
either <- RE.toEither (liftAff $ throwError $ Exn.error "foo") unit
|
||||
isLeft either `shouldEqual` true
|
||||
it "liftEffect catches exceptions" $ const do
|
||||
either <- RE.toEither (liftEffect $ throwError $ Exn.error "foo") unit
|
||||
isLeft either `shouldEqual` true
|
||||
it "liftExcept catches exceptions" $ const do
|
||||
either <- RE.toEither (throwError $ pure $ Other $ Exn.error "foo") unit
|
||||
isLeft either `shouldEqual` true
|
||||
it "fork > join catches Fiber exceptions" $ const do
|
||||
either <- flip RE.toEither unit do
|
||||
fiber <- fork (liftAff $ throwError $ Exn.error "foo") :: RE Unit Aff _
|
||||
liftAff $ delay $ wrap 1.0
|
||||
join fiber
|
||||
isLeft either `shouldEqual` true
|
||||
it "bracket catches error in acq" $ const do
|
||||
either <-
|
||||
flip RE.toEither unit
|
||||
$ bracket
|
||||
(liftAff $ throwError $ Exn.error "foo")
|
||||
(const $ const $ pure unit)
|
||||
(const $ pure unit)
|
||||
isLeft either `shouldEqual` true
|
||||
it "bracket catches error in rel" $ const do
|
||||
either <-
|
||||
flip RE.toEither unit
|
||||
$ bracket
|
||||
(pure unit)
|
||||
(const $ const $ liftAff $ throwError $ Exn.error "foo")
|
||||
(const $ pure unit)
|
||||
isLeft either `shouldEqual` true
|
||||
it "bracket catches error in go" $ const do
|
||||
either <-
|
||||
flip RE.toEither unit
|
||||
$ bracket
|
||||
(pure unit)
|
||||
(const $ const $ pure unit)
|
||||
(const $ liftAff $ throwError $ Exn.error "foo")
|
||||
isLeft either `shouldEqual` true
|
||||
it "forked bracket catches error in acq" $ const do
|
||||
either <- flip RE.toEither unit do
|
||||
fiber <-
|
||||
fork
|
||||
$ bracket
|
||||
(liftAff $ throwError $ Exn.error "foo")
|
||||
(const $ const $ pure unit)
|
||||
(const $ pure unit)
|
||||
liftAff $ delay $ wrap 1.0
|
||||
join fiber
|
||||
isLeft either `shouldEqual` true
|
||||
it "forked bracket catches error in rel" $ const do
|
||||
either <- flip RE.toEither unit do
|
||||
fiber <-
|
||||
fork
|
||||
$ bracket
|
||||
(pure unit)
|
||||
(const $ const $ liftAff $ throwError $ Exn.error "foo")
|
||||
(const $ pure unit)
|
||||
liftAff $ delay $ wrap 1.0
|
||||
join fiber
|
||||
isLeft either `shouldEqual` true
|
||||
it "forked bracket catches error in go" $ const do
|
||||
either <- flip RE.toEither unit do
|
||||
fiber <-
|
||||
fork
|
||||
$ bracket
|
||||
(pure unit)
|
||||
(const $ const $ pure unit)
|
||||
(const $ liftAff $ throwError $ Exn.error "foo")
|
||||
liftAff $ delay $ wrap 1.0
|
||||
join fiber
|
||||
isLeft either `shouldEqual` true
|
||||
it "catches errors in `parSequence`" $ const do
|
||||
either <-
|
||||
flip RE.toEither unit
|
||||
$ parSequence
|
||||
$ [ liftAff $ throwError $ Exn.error "a"
|
||||
, pure "a"
|
||||
]
|
||||
isLeft either `shouldEqual` true
|
||||
it "catches errors in `parOneOf`" $ const do
|
||||
either <-
|
||||
flip RE.toEither unit
|
||||
$ parOneOf
|
||||
$ [ liftAff $ throwError $ Exn.error "a"
|
||||
, liftAff $ throwError $ Exn.error "b"
|
||||
]
|
||||
isLeft either `shouldEqual` true
|
||||
@@ -7,6 +7,7 @@ import Effect.Aff (finally, forkAff, joinFiber)
|
||||
import Effect.Aff.Postgres.Client as Client
|
||||
import Effect.Aff.Postgres.Pool as Pool
|
||||
import Effect.Class (liftEffect)
|
||||
import Effect.Postgres.Error.Except as X
|
||||
import Test.Common (config, onceAff, withPool)
|
||||
import Test.Spec (Spec, around, describe, it)
|
||||
import Test.Spec.Assertions (expectError, shouldEqual)
|
||||
@@ -20,78 +21,78 @@ spec = describe "Pool" do
|
||||
void $ liftEffect $ Pool.make cfg
|
||||
around withPool do
|
||||
it "idleCount, totalCount" \p -> do
|
||||
a <- Pool.connect p
|
||||
b <- Pool.connect p
|
||||
c <- Pool.connect p
|
||||
liftEffect $ Pool.release p a
|
||||
liftEffect $ Pool.release p b
|
||||
finally (liftEffect $ Pool.release p c) do
|
||||
a <- X.run $ Pool.connect p
|
||||
b <- X.run $ Pool.connect p
|
||||
c <- X.run $ Pool.connect p
|
||||
liftEffect $ X.run $ Pool.release p a
|
||||
liftEffect $ X.run $ Pool.release p b
|
||||
finally (liftEffect $ X.run $ Pool.release p c) do
|
||||
Pool.clientIdleCount p `shouldEqual` 2
|
||||
Pool.clientCount p `shouldEqual` 3
|
||||
Pool.clientIdleCount p `shouldEqual` 3
|
||||
Pool.clientCount p `shouldEqual` 3
|
||||
it "waitingCount" \p -> do
|
||||
a <- Pool.connect p
|
||||
b <- Pool.connect p
|
||||
c <- Pool.connect p
|
||||
dFiber <- forkAff $ Pool.connect p
|
||||
a <- X.run $ Pool.connect p
|
||||
b <- X.run $ Pool.connect p
|
||||
c <- X.run $ Pool.connect p
|
||||
dFiber <- forkAff $ X.run $ Pool.connect p
|
||||
let
|
||||
rel =
|
||||
do
|
||||
void $ liftEffect $ traverse (Pool.release p) [ a, b, c ]
|
||||
void $ liftEffect $ X.run $ traverse (Pool.release p) [ a, b, c ]
|
||||
d <- joinFiber dFiber
|
||||
liftEffect $ Pool.release p d
|
||||
liftEffect $ X.run $ Pool.release p d
|
||||
finally rel $ Pool.clientWaitingCount p `shouldEqual` 1
|
||||
describe "events" do
|
||||
it "connect" \p -> do
|
||||
expect <- forkAff $ void $ onceAff Pool.connectE p
|
||||
c <- Pool.connect p
|
||||
finally (liftEffect $ Pool.release p c) $ joinFiber expect
|
||||
c <- X.run $ Pool.connect p
|
||||
finally (liftEffect $ X.run $ Pool.release p c) $ joinFiber expect
|
||||
it "acquire" \p -> do
|
||||
c <- Pool.connect p
|
||||
liftEffect $ Pool.release p c
|
||||
c <- X.run$ Pool.connect p
|
||||
liftEffect $ X.run$ Pool.release p c
|
||||
expect <- forkAff do
|
||||
c'' <- onceAff Pool.acquireE p
|
||||
refEq c c'' `shouldEqual` true
|
||||
c' <- Pool.connect p
|
||||
finally (liftEffect $ Pool.release p c') $ joinFiber expect
|
||||
c' <- X.run $ Pool.connect p
|
||||
finally (liftEffect $ X.run$ Pool.release p c') $ joinFiber expect
|
||||
it "release" \p -> do
|
||||
c <- Pool.connect p
|
||||
c <- X.run $ Pool.connect p
|
||||
expect <- forkAff do
|
||||
c' <- onceAff Pool.releaseE p
|
||||
refEq c c' `shouldEqual` true
|
||||
liftEffect $ Pool.release p c
|
||||
liftEffect $ X.run $ Pool.release p c
|
||||
joinFiber expect
|
||||
it "remove" \p -> do
|
||||
c <- Pool.connect p
|
||||
c <- X.run $ Pool.connect p
|
||||
expect <- forkAff do
|
||||
c' <- onceAff Pool.removeE p
|
||||
refEq c c' `shouldEqual` true
|
||||
liftEffect $ Pool.destroy p c
|
||||
liftEffect $ X.run $ Pool.destroy p c
|
||||
joinFiber expect
|
||||
it "connect" \p -> do
|
||||
c <- Pool.connect p
|
||||
let rel = liftEffect $ Pool.release p c
|
||||
finally rel $ shouldEqual 1 =<< Client.query "select 1" c
|
||||
c <- X.run $ Pool.connect p
|
||||
let rel = liftEffect $ X.run $ Pool.release p c
|
||||
finally rel $ shouldEqual 1 =<< X.run (Client.query "select 1" c)
|
||||
describe "destroy" do
|
||||
it "throws on query after destroy" \p -> do
|
||||
c <- Pool.connect p
|
||||
liftEffect $ Pool.destroy p c
|
||||
expectError $ Client.exec "select 1" c
|
||||
c <- X.run $ Pool.connect p
|
||||
liftEffect $ X.run $ Pool.destroy p c
|
||||
expectError $ X.run $ Client.exec "select 1" c
|
||||
it "different client yielded after destroy" \p -> do
|
||||
a <- Pool.connect p
|
||||
liftEffect $ Pool.destroy p a
|
||||
b <- Pool.connect p
|
||||
liftEffect $ Pool.destroy p b
|
||||
a <- X.run $ Pool.connect p
|
||||
liftEffect $ X.run $ Pool.destroy p a
|
||||
b <- X.run $ Pool.connect p
|
||||
liftEffect $ X.run $ Pool.destroy p b
|
||||
refEq a b `shouldEqual` false
|
||||
describe "release" do
|
||||
it "allows reuse" \p -> do
|
||||
a <- Pool.connect p
|
||||
liftEffect $ Pool.release p a
|
||||
b <- Pool.connect p
|
||||
liftEffect $ Pool.release p b
|
||||
a <- X.run $ Pool.connect p
|
||||
liftEffect $ X.run $ Pool.release p a
|
||||
b <- X.run $ Pool.connect p
|
||||
liftEffect $ X.run $ Pool.release p b
|
||||
refEq a b `shouldEqual` true
|
||||
it "throws when invoked twice" \p -> do
|
||||
c <- Pool.connect p
|
||||
liftEffect $ Pool.release p c
|
||||
expectError $ liftEffect $ Pool.release p c
|
||||
c <- X.run $ Pool.connect p
|
||||
liftEffect $ X.run $ Pool.release p c
|
||||
expectError $ liftEffect $ X.run $ Pool.release p c
|
||||
|
||||
@@ -23,7 +23,9 @@ import Node.EventEmitter as Event
|
||||
import Test.Control.Monad.Postgres as Test.Control.Monad.Postgres
|
||||
import Test.Data.Postgres as Test.Data.Postgres
|
||||
import Test.Data.Postgres.Custom as Test.Data.Postgres.Custom
|
||||
import Test.Data.Postgres.Interval as Test.Data.Postgres.Interval
|
||||
import Test.Effect.Postgres.Client as Test.Effect.Postgres.Client
|
||||
import Test.Effect.Postgres.Error as Test.Effect.Postgres.Error
|
||||
import Test.Effect.Postgres.Pool as Test.Effect.Postgres.Pool
|
||||
import Test.Spec.Reporter (specReporter)
|
||||
import Test.Spec.Runner (runSpec)
|
||||
@@ -63,8 +65,10 @@ main = launchAff_ do
|
||||
bracket spawnDb killDb
|
||||
$ const
|
||||
$ runSpec [ specReporter ] do
|
||||
Test.Effect.Postgres.Error.spec
|
||||
Test.Data.Postgres.Custom.spec
|
||||
Test.Data.Postgres.spec
|
||||
Test.Data.Postgres.Interval.spec
|
||||
Test.Effect.Postgres.Client.spec
|
||||
Test.Effect.Postgres.Pool.spec
|
||||
Test.Control.Monad.Postgres.spec
|
||||
|
||||
Reference in New Issue
Block a user