├── .gitignore ├── License.md ├── Readme.md ├── clickhouse.go ├── escape.go ├── fetch.go ├── go.mod ├── go.sum └── limiter.go /.gitignore: -------------------------------------------------------------------------------- 1 | .idea 2 | *.iml -------------------------------------------------------------------------------- /License.md: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /Readme.md: -------------------------------------------------------------------------------- 1 | # Golang Clickhouse connector 2 | 3 | ## Create new connection 4 | 5 | ```go 6 | package main 7 | 8 | import ( 9 | ch "github.com/leprosus/golang-clickhouse" 10 | ) 11 | 12 | var ( 13 | user = "clickhouse.user" 14 | pass = "clickhouse.pass" 15 | host = "clickhouse.host" 16 | port = 8123 17 | ) 18 | 19 | func init(){ 20 | conn := ch.New(host, port, user, pass) 21 | 22 | // Also you can preset maximum memory usage limit to execute one query 23 | conn.MaxMemoryUsage(4 * clickhouse.GigaByte) 24 | } 25 | ``` 26 | 27 | ## Query rows 28 | 29 | ```go 30 | conn := ch.New(host, port, user, pass) 31 | 32 | iter, err := conn.Fetch("SELECT `database`, `name`, `engine` FROM system.tables") 33 | if err != nil { 34 | panic(err) 35 | } 36 | 37 | for iter.Next() { 38 | result := iter.Result 39 | 40 | database, _ := result.String("database") 41 | name, _ := result.String("name") 42 | engine, _ := result.String("engine") 43 | 44 | println(database, country, engine) 45 | } 46 | ``` 47 | 48 | ## Execute insert 49 | 50 | ```go 51 | conn := ch.New(host, port, user, pass) 52 | 53 | query := fmt.Sprintf("INSERT INTO db.table (SomeFiled) VALUES ('%s')", "Some value") 54 | conn.Exec(query) 55 | ``` 56 | 57 | ## Preset you own logging 58 | 59 | ```go 60 | ch.Debug(func(message string) { 61 | log.Printf("DEBUG: %s\n", message) 62 | }) 63 | 64 | ch.Info(func(message string) { 65 | log.Printf("INFO: %s\n", message) 66 | } 67 | 68 | ch.Info(func(message string) { 69 | log.Printf("WARN: %s\n", message) 70 | } 71 | 72 | ch.Error(func(message string) { 73 | log.Printf("ERROR: %s\n", message) 74 | } 75 | 76 | ch.Fatal(func(message string) { 77 | log.Printf("FATAL: %s\n", message) 78 | }} 79 | 80 | ``` 81 | 82 | ## Values escaping 83 | 84 | ```go 85 | value := "Here is tab. This is line comment --" 86 | escaped := clickhouse.Escape(value) 87 | fmt.Print(escaped) //Here\tis tab. This is line comment \-\- 88 | ``` 89 | 90 | ## List all methods 91 | 92 | ### Connection 93 | 94 | * clickhouse.New(host, port, user, pass) - creates connection 95 | * conn.Attempts(attempts, wait) - sets amount of attempts and time awaiting after fail request (wait in seconds) 96 | * conn.MaxMemoryUsage(limit) - sets maximum memory usage per query (limit in bytes) 97 | * conn.MaxRequests(limit) - sets maximum requests at the same time 98 | * conn.ConnectTimeout(timeout) - sets connection timeout (timeout in seconds) 99 | * conn.SendTimeout(timeout) - sets send timeout (timeout in seconds) 100 | * conn.ReceiveTimeout(timeout) - sets receive timeout (timeout in seconds) 101 | * conn.Compression(flag) - sets response compression 102 | 103 | ### Logging 104 | 105 | * clickhouse.Debug(func(message string)) - sets custom logger for debug 106 | * clickhouse.Info(func(message string)) - sets custom logger for info 107 | * clickhouse.Warn(func(message string)) - sets custom logger for warn 108 | * clickhouse.Error(func(message string)) - sets custom logger for error 109 | * clickhouse.Fatal(func(message string)) - sets custom logger for fatal 110 | 111 | ### Fetching 112 | 113 | * conn.Fetch(query) - executes, fetches query and returns iterator and error 114 | * conn.ForcedFetch(query) - executes, fetches query and returns iterator and error without requests limits 115 | * conn.FetchOne(query) - executes, fetches query and returns first result and error 116 | * conn.ForcedFetchOne(query) - executes, fetches query and returns first result and error without requests limits 117 | * conn.Exec(query) - executes query and returns error 118 | * conn.ForcedExec(query) - executes query and returns error without requests limits 119 | * conn.InsertBatch(query) - inserts batch data from file into `database.table` table with TabSeparated, TabSeparatedWithNames, CSV, CSVWithNames format 120 | 121 | ### Iterator 122 | 123 | * iter.Next() - checks if has more data 124 | * iter.Err() - returns error if exist or nil 125 | * iter.Result() - returns result 126 | * iter.Close() - closes data stream 127 | 128 | ### Result 129 | 130 | * result.Columns() - returns columns list 131 | * result.Exist("FieldName") - returns true if field is exist or false 132 | * result.String("FieldName") - returns string value and error 133 | * result.Bytes("FieldName") - returns bytes slice value and error 134 | * result.Bool("FieldName") - returns boolean value and error 135 | * result.UInt8("FieldName") - returns unsigned int8 value and error 136 | * result.UInt16("FieldName") - returns unsigned int16 value and error 137 | * result.UInt32("FieldName") - returns unsigned int32 value and error 138 | * result.UInt64("FieldName") - returns unsigned int64 value and error 139 | * result.Int8("FieldName") - returns int8 value and error 140 | * result.Int16("FieldName") - returns int16 value and error 141 | * result.Int32("FieldName") - returns int32 value and error 142 | * result.Int64("FieldName") - returns int64 value and error 143 | * result.Float32("FieldName") - returns float32 value and error 144 | * result.Float64("FieldName") - returns float64 value and error 145 | * result.Date("FieldName") - parses data YYYY-MM-DD and returns time value and error 146 | * result.DateTime("FieldName") - parses data YYYY-MM-DD HH:MM:SS and returns time value and error 147 | 148 | ### Escaping 149 | 150 | * clickhouse.Escape("ValueToEscape") - escapes special symbols 151 | * clickhouse.Unescape("ValueToUndoEscaping") - undoes escaping of special symbols -------------------------------------------------------------------------------- /clickhouse.go: -------------------------------------------------------------------------------- 1 | package clickhouse 2 | 3 | import ( 4 | "bufio" 5 | "compress/gzip" 6 | "errors" 7 | "fmt" 8 | "io" 9 | "io/ioutil" 10 | "net/http" 11 | "net/url" 12 | "regexp" 13 | "strings" 14 | "sync" 15 | "sync/atomic" 16 | "time" 17 | ) 18 | 19 | const ( 20 | MegaByte = 1024 * 1024 21 | GigaByte = 1024 * MegaByte 22 | ) 23 | 24 | type Conn struct { 25 | Limiter 26 | 27 | host string 28 | port int 29 | user string 30 | pass string 31 | maxMemoryUsage int32 32 | connectTimeout int32 33 | sendTimeout int32 34 | receiveTimeout int32 35 | compression int32 36 | attemptsAmount uint32 37 | attemptWait uint32 38 | protocol string 39 | mux sync.Mutex 40 | } 41 | 42 | type Iter struct { 43 | conn *Conn 44 | columns map[string]int 45 | readCloser io.ReadCloser 46 | reader *bufio.Reader 47 | err error 48 | Result Result 49 | isClosed bool 50 | } 51 | 52 | type Result struct { 53 | data map[string]string 54 | } 55 | 56 | type Format string 57 | 58 | const ( 59 | TSV Format = "TabSeparated" 60 | TSVWithNames Format = "TabSeparatedWithNames" 61 | CSV Format = "CSV" 62 | CSVWithNames Format = "CSVWithNames" 63 | ) 64 | 65 | type config struct { 66 | sync.Once 67 | logger logger 68 | } 69 | 70 | type logger struct { 71 | debug func(message string) 72 | info func(message string) 73 | warn func(message string) 74 | error func(message string) 75 | fatal func(message string) 76 | } 77 | 78 | var cfg = config{ 79 | logger: logger{ 80 | debug: func(message string) {}, 81 | info: func(message string) {}, 82 | warn: func(message string) {}, 83 | error: func(message string) {}, 84 | fatal: func(message string) {}}} 85 | 86 | func New(host string, port int, user string, pass string) *Conn { 87 | cfg.logger.info("Clickhouse is initialized") 88 | 89 | return &Conn{ 90 | host: host, 91 | port: port, 92 | user: user, 93 | pass: pass, 94 | protocol: "https", 95 | connectTimeout: -1, 96 | receiveTimeout: -1, 97 | sendTimeout: -1, 98 | maxMemoryUsage: -1, 99 | compression: -1, 100 | attemptsAmount: 1, 101 | attemptWait: 0} 102 | } 103 | 104 | // Debug sets logger for debug 105 | func Debug(callback func(message string)) { 106 | cfg.logger.debug = callback 107 | cfg.logger.debug("Set custom debug logger") 108 | } 109 | 110 | // Info sets logger for into 111 | func Info(callback func(message string)) { 112 | cfg.logger.info = callback 113 | cfg.logger.debug("Set custom info logger") 114 | } 115 | 116 | // Warn sets logger for warning 117 | func Warn(callback func(message string)) { 118 | cfg.logger.warn = callback 119 | cfg.logger.debug("Set custom warning logger") 120 | } 121 | 122 | // Error sets logger for error 123 | func Error(callback func(message string)) { 124 | cfg.logger.error = callback 125 | cfg.logger.debug("Set custom error logger") 126 | } 127 | 128 | // Fatal sets logger for fatal 129 | func Fatal(callback func(message string)) { 130 | cfg.logger.fatal = callback 131 | cfg.logger.debug("Set custom fatal logger") 132 | } 133 | 134 | // Attempts sets amount of attempt query execution 135 | func (conn *Conn) Attempts(amount int, wait int) { 136 | atomic.StoreUint32(&conn.attemptsAmount, uint32(amount)) 137 | atomic.StoreUint32(&conn.attemptWait, uint32(wait)) 138 | 139 | message := fmt.Sprintf("Set attempts amount (%d) and wait (%d seconds)", amount, wait) 140 | cfg.logger.debug(message) 141 | } 142 | 143 | // Protocol sets new protocol value 144 | func (conn *Conn) Protocol(protocol string) { 145 | conn.mux.Lock() 146 | conn.protocol = protocol 147 | conn.mux.Unlock() 148 | message := fmt.Sprintf("Set protocol = %s", protocol) 149 | cfg.logger.debug(message) 150 | } 151 | 152 | // MaxMemoryUsage sets new maximum memory usage value 153 | func (conn *Conn) MaxMemoryUsage(limit int) { 154 | if limit < 0 { 155 | return 156 | } 157 | 158 | atomic.StoreInt32(&conn.maxMemoryUsage, int32(limit)) 159 | 160 | message := fmt.Sprintf("Set max_memory_usage = %d", limit) 161 | cfg.logger.debug(message) 162 | } 163 | 164 | // ConnectTimeout sets new connection timeout 165 | func (conn *Conn) ConnectTimeout(timeout int) { 166 | if timeout < 0 { 167 | return 168 | } 169 | 170 | atomic.StoreInt32(&conn.connectTimeout, int32(timeout)) 171 | 172 | message := fmt.Sprintf("Set connect_timeout = %d s", timeout) 173 | cfg.logger.debug(message) 174 | } 175 | 176 | // SendTimeout sets new send timeout 177 | func (conn *Conn) SendTimeout(timeout int) { 178 | if timeout < 0 { 179 | return 180 | } 181 | 182 | atomic.StoreInt32(&conn.sendTimeout, int32(timeout)) 183 | 184 | message := fmt.Sprintf("Set send_timeout = %d s", timeout) 185 | cfg.logger.debug(message) 186 | } 187 | 188 | // Compression sets new send timeout 189 | func (conn *Conn) Compression(compression bool) { 190 | var compInt int32 = 0 191 | if compression { 192 | compInt = 1 193 | } 194 | 195 | atomic.StoreInt32(&conn.compression, compInt) 196 | 197 | message := fmt.Sprintf("Set compression = %d", conn.compression) 198 | cfg.logger.debug(message) 199 | } 200 | 201 | // ReceiveTimeout sets new receive timeout 202 | func (conn *Conn) ReceiveTimeout(timeout int) { 203 | atomic.StoreInt32(&conn.receiveTimeout, int32(timeout)) 204 | 205 | message := fmt.Sprintf("Set receive_timeout = %d s", timeout) 206 | cfg.logger.debug(message) 207 | } 208 | 209 | // Exec executes new query 210 | func (conn *Conn) Exec(query string) error { 211 | conn.waitForRest() 212 | conn.increase() 213 | defer conn.reduce() 214 | 215 | return conn.ForcedExec(query) 216 | } 217 | 218 | // ForcedExec executes new query without requests limits 219 | func (conn *Conn) ForcedExec(query string) error { 220 | message := fmt.Sprintf("Try to execute: %s", cutOffQuery(query, 500)) 221 | cfg.logger.debug(message) 222 | 223 | reader, err := conn.doQuery(query) 224 | if err != nil { 225 | message = fmt.Sprintf("Catch error %s", err.Error()) 226 | cfg.logger.error(message) 227 | 228 | return err 229 | } 230 | 231 | defer reader.Close() 232 | 233 | _, err = ioutil.ReadAll(reader) 234 | if err != nil { 235 | return err 236 | } 237 | 238 | message = fmt.Sprintf("The query is executed %s", cutOffQuery(query, 500)) 239 | cfg.logger.debug(message) 240 | 241 | return nil 242 | } 243 | 244 | // InsertBatch inserts TSV data into `database.table` table 245 | func (conn *Conn) InsertBatch(database, table string, columns []string, format Format, tsvReader io.Reader) error { 246 | var query string 247 | if len(columns) == 0 { 248 | query = fmt.Sprintf("INSERT INTO %s.%s FORMAT %s\n", database, table, format) 249 | } else { 250 | query = fmt.Sprintf("INSERT INTO %s.%s (%s) FORMAT %s\n", database, table, strings.Join(columns, ", "), format) 251 | } 252 | 253 | reader := bufio.NewReader(tsvReader) 254 | 255 | var ( 256 | bs []byte 257 | err error 258 | ) 259 | 260 | for { 261 | bs, err = reader.ReadBytes('\b') 262 | if err == io.EOF { 263 | break 264 | } else if err != nil { 265 | return err 266 | } 267 | 268 | query += string(bs) 269 | } 270 | 271 | query += "\n" 272 | 273 | err = conn.Exec(query) 274 | 275 | return err 276 | } 277 | 278 | // Fetch executes new query and fetches all data 279 | func (conn *Conn) Fetch(query string) (Iter, error) { 280 | conn.waitForRest() 281 | conn.increase() 282 | defer conn.reduce() 283 | 284 | return conn.ForcedFetch(query) 285 | } 286 | 287 | // ForcedFetch executes new query and fetches all data without requests limits 288 | func (conn *Conn) ForcedFetch(query string) (Iter, error) { 289 | message := fmt.Sprintf("Try to execute: %s", cutOffQuery(query, 500)) 290 | cfg.logger.debug(message) 291 | 292 | re := regexp.MustCompile("(FORMAT [A-Za-z0-9]+)? *;? *$") 293 | query = re.ReplaceAllString(query, " FORMAT TabSeparatedWithNames") 294 | 295 | iter := Iter{conn: conn} 296 | 297 | var err error 298 | iter.readCloser, err = conn.doQuery(query) 299 | 300 | if err != nil { 301 | return iter, err 302 | } 303 | 304 | iter.columns = make(map[string]int) 305 | 306 | cfg.logger.debug("Open stream to fetch") 307 | 308 | iter.reader = bufio.NewReader(iter.readCloser) 309 | bytes, hasMore := iter.read() 310 | if !hasMore { 311 | err := errors.New("can't get columns names") 312 | 313 | message := fmt.Sprintf("Catch error %s", err.Error()) 314 | cfg.logger.fatal(message) 315 | 316 | return iter, err 317 | } 318 | 319 | line := string(bytes) 320 | 321 | matches := strings.Split(line, "\t") 322 | for index, column := range matches { 323 | iter.columns[column] = index 324 | } 325 | 326 | cfg.logger.debug("Load fields names") 327 | 328 | return iter, nil 329 | } 330 | 331 | // FetchOne executes new query and fetches one row 332 | func (conn *Conn) FetchOne(query string) (Result, error) { 333 | conn.waitForRest() 334 | conn.increase() 335 | defer conn.reduce() 336 | 337 | return conn.ForcedFetchOne(query) 338 | } 339 | 340 | // ForcedFetchOne executes new query and fetches one row without requests limits 341 | func (conn *Conn) ForcedFetchOne(query string) (Result, error) { 342 | iter, err := conn.ForcedFetch(query) 343 | if err != nil { 344 | message := fmt.Sprintf("Catch error %s", err.Error()) 345 | cfg.logger.error(message) 346 | 347 | return Result{}, err 348 | } 349 | 350 | defer iter.Close() 351 | 352 | if iter.Next() { 353 | return iter.Result, nil 354 | } 355 | 356 | return Result{}, nil 357 | } 358 | 359 | // Next returns next row of data 360 | func (iter *Iter) Next() bool { 361 | cfg.logger.debug("Check if has more data") 362 | 363 | bytes, hasMore := iter.read() 364 | if !hasMore { 365 | return false 366 | } 367 | 368 | line := string(bytes) 369 | 370 | matches := strings.Split(line, "\t") 371 | 372 | iter.Result = Result{} 373 | iter.Result.data = make(map[string]string) 374 | for column, index := range iter.columns { 375 | iter.Result.data[column] = matches[index] 376 | } 377 | 378 | cfg.logger.debug("Load new data") 379 | 380 | return true 381 | } 382 | 383 | func (iter *Iter) read() ([]byte, bool) { 384 | var bytes []byte 385 | bytes, iter.err = iter.reader.ReadBytes('\n') 386 | 387 | l := len(bytes) 388 | if l > 0 { 389 | bytes = bytes[0 : len(bytes)-1] 390 | } 391 | 392 | if iter.err == io.EOF { 393 | iter.err = nil 394 | iter.Close() 395 | 396 | return bytes, false 397 | } else if iter.err != nil { 398 | message := fmt.Sprintf("Catch error %s", iter.err.Error()) 399 | cfg.logger.fatal(message) 400 | 401 | return bytes, false 402 | } 403 | 404 | return bytes, true 405 | } 406 | 407 | // Err returns error of iterator 408 | func (iter Iter) Err() error { 409 | return iter.err 410 | } 411 | 412 | // Close closes stream 413 | func (iter Iter) Close() { 414 | if !iter.isClosed { 415 | iter.readCloser.Close() 416 | 417 | iter.isClosed = true 418 | 419 | cfg.logger.debug("The query is fetched") 420 | } 421 | } 422 | 423 | func (conn *Conn) getFQDN(toConnect bool) string { 424 | pass := conn.pass 425 | masked := strings.Repeat("*", len(conn.pass)) 426 | 427 | if !toConnect { 428 | pass = masked 429 | } 430 | 431 | fqnd := fmt.Sprintf("%s:%s@%s:%d", conn.user, pass, conn.host, conn.port) 432 | 433 | cfg.Do(func() { 434 | message := fmt.Sprintf("Connection FQDN is %s:%s@%s:%d", conn.user, masked, conn.host, conn.port) 435 | cfg.logger.info(message) 436 | }) 437 | 438 | return fqnd 439 | } 440 | 441 | func (conn *Conn) doQuery(query string) (io.ReadCloser, error) { 442 | var ( 443 | attempts uint32 = 0 444 | req *http.Request 445 | res *http.Response 446 | err error 447 | ) 448 | 449 | for attempts < atomic.LoadUint32(&conn.attemptsAmount) { 450 | maxMemoryUsage := atomic.LoadInt32(&conn.maxMemoryUsage) 451 | connectTimeout := atomic.LoadInt32(&conn.connectTimeout) 452 | sendTimeout := atomic.LoadInt32(&conn.sendTimeout) 453 | receiveTimeout := atomic.LoadInt32(&conn.receiveTimeout) 454 | compression := atomic.LoadInt32(&conn.compression) 455 | 456 | var timeout int32 = 0 457 | 458 | if connectTimeout > 0 { 459 | timeout += connectTimeout 460 | } 461 | 462 | if sendTimeout > 0 { 463 | timeout += sendTimeout 464 | } 465 | 466 | if receiveTimeout > 0 { 467 | timeout += receiveTimeout 468 | } 469 | 470 | client := http.Client{} 471 | if timeout > 0 { 472 | client.Timeout = time.Duration(timeout) * time.Second 473 | } 474 | 475 | options := url.Values{} 476 | if maxMemoryUsage > 0 { 477 | options.Set("max_memory_usage", fmt.Sprintf("%d", maxMemoryUsage)) 478 | } 479 | 480 | if connectTimeout > 0 { 481 | options.Set("connect_timeout", fmt.Sprintf("%d", connectTimeout)) 482 | } 483 | 484 | if sendTimeout > 0 { 485 | options.Set("send_timeout", fmt.Sprintf("%d", sendTimeout)) 486 | } 487 | 488 | if receiveTimeout > 0 { 489 | options.Set("receive_timeout", fmt.Sprintf("%d", receiveTimeout)) 490 | } 491 | 492 | if compression == 1 { 493 | options.Set("enable_http_compression", fmt.Sprintf("%d", compression)) 494 | } 495 | 496 | urlStr := conn.protocol + "://" + conn.getFQDN(true) + "/?" + options.Encode() 497 | 498 | req, err = http.NewRequest("POST", urlStr, strings.NewReader(query)) 499 | if err != nil { 500 | message := fmt.Sprintf("Can't connect to host %s: %s", conn.getFQDN(false), err.Error()) 501 | cfg.logger.fatal(message) 502 | 503 | return nil, errors.New(message) 504 | } 505 | 506 | if compression == 1 { 507 | req.Header.Add("Accept-Encoding", "gzip") 508 | } 509 | req.Header.Set("Content-Type", "text/plain") 510 | req.Header.Set("Pragma", "no-cache") 511 | req.Header.Set("Cache-Control", "no-cache") 512 | 513 | req.Close = true 514 | 515 | if attempts > 0 { 516 | exponentialTime := attempts * conn.attemptWait 517 | 518 | time.Sleep(time.Duration(exponentialTime) * time.Second) 519 | } 520 | 521 | attempts++ 522 | 523 | res, err = client.Do(req) 524 | 525 | if atomic.LoadUint32(&conn.attemptsAmount) > 1 { 526 | if err != nil { 527 | message := fmt.Sprintf("Catch warning %s", err.Error()) 528 | cfg.logger.warn(message) 529 | 530 | if strings.Contains(err.Error(), "Memory limit") { 531 | return nil, errors.New(message) 532 | } 533 | } else if err = handleErrStatus(res); err != nil { 534 | message := fmt.Sprintf("Catch warning %s", err.Error()) 535 | cfg.logger.warn(message) 536 | } else { 537 | return getReader(res) 538 | } 539 | } 540 | } 541 | 542 | if err != nil { 543 | message := fmt.Sprintf("Can't do request to host %s: %s", conn.getFQDN(false), err.Error()) 544 | cfg.logger.error(message) 545 | 546 | return nil, errors.New(message) 547 | } else if err = handleErrStatus(res); err != nil { 548 | message := fmt.Sprintf("Catch error %s", err.Error()) 549 | cfg.logger.error(message) 550 | 551 | return nil, errors.New(message) 552 | } 553 | 554 | return res.Body, nil 555 | } 556 | 557 | func getReader(res *http.Response) (io.ReadCloser, error) { 558 | switch res.Header.Get("Content-Encoding") { 559 | case "gzip": 560 | reader, err := gzip.NewReader(res.Body) 561 | if err != nil { 562 | return nil, err 563 | } 564 | 565 | return reader, nil 566 | default: 567 | return res.Body, nil 568 | } 569 | } 570 | 571 | func handleErrStatus(res *http.Response) error { 572 | if res.StatusCode != 200 { 573 | reader, err := getReader(res) 574 | if err != nil { 575 | return err 576 | } 577 | defer reader.Close() 578 | 579 | bytes, err := ioutil.ReadAll(reader) 580 | 581 | if err != nil { 582 | return err 583 | } 584 | 585 | if len(bytes) == 0 { 586 | return errors.New("empty error body") 587 | } 588 | 589 | text := string(bytes) 590 | 591 | if text[0] == '<' { 592 | re := regexp.MustCompile("([^<]+)") 593 | list := re.FindAllString(text, -1) 594 | 595 | return errors.New(list[0]) 596 | } else { 597 | return errors.New(text) 598 | } 599 | } 600 | 601 | return nil 602 | } 603 | 604 | func cutOffQuery(query string, length int) string { 605 | if len(query) > length { 606 | return query[0:length] + " ..." 607 | } 608 | 609 | return query 610 | } 611 | -------------------------------------------------------------------------------- /escape.go: -------------------------------------------------------------------------------- 1 | package clickhouse 2 | 3 | // Escape escapes special symbols 4 | func Escape(line string) string { 5 | result := "" 6 | 7 | length := len(line) 8 | for i := 0; i < length; i++ { 9 | char := line[i : i+1] 10 | 11 | switch char { 12 | case "\b": 13 | result += "\\b" 14 | case "\f": 15 | result += "\\f" 16 | case "\r": 17 | result += "\\r" 18 | case "\n": 19 | result += "\\n" 20 | case "\t": 21 | result += "\\t" 22 | case `'`: 23 | result += `\'` 24 | case `\`: 25 | result += `\\` 26 | case `/`: 27 | result += `\/` 28 | case `-`: 29 | result += `\-` 30 | default: 31 | result += string(char) 32 | } 33 | } 34 | 35 | return result 36 | } 37 | 38 | // Unescape undoes escaping of special symbols 39 | func Unescape(line string) string { 40 | result := "" 41 | 42 | length := len(line) 43 | for i := 0; i < length; i += 2 { 44 | if i >= length-1 { 45 | result += line[i : i+1] 46 | break 47 | } 48 | 49 | pair := line[i : i+2] 50 | 51 | switch pair { 52 | case "\\b": 53 | result += "\b" 54 | case "\\f": 55 | result += "\f" 56 | case "\\r": 57 | result += "\r" 58 | case "\\n": 59 | result += "\n" 60 | case "\\t": 61 | result += "\t" 62 | case `\'`: 63 | result += `'` 64 | case `\\`: 65 | result += `\` 66 | case `\/`: 67 | result += `/` 68 | case `\-`: 69 | result += `-` 70 | default: 71 | result += line[i : i+1] 72 | i-- 73 | } 74 | } 75 | 76 | return result 77 | } 78 | -------------------------------------------------------------------------------- /fetch.go: -------------------------------------------------------------------------------- 1 | package clickhouse 2 | 3 | import ( 4 | "fmt" 5 | "strconv" 6 | "time" 7 | ) 8 | 9 | //TODO maybe need to add GetArray func(column string) (Type, error) where Type is all listen types above 10 | 11 | // Columns returns columns list 12 | func (result Result) Columns() (columns []string) { 13 | for column := range result.data { 14 | columns = append(columns, column) 15 | } 16 | 17 | return columns 18 | } 19 | 20 | // Exist returns true if field is exist or false 21 | func (result Result) Exist(column string) bool { 22 | cfg.logger.debug(fmt.Sprintf("Try to check if exist by `%s`", column)) 23 | 24 | _, ok := result.data[column] 25 | 26 | return ok 27 | } 28 | 29 | // String returns value of string 30 | func (result Result) String(column string) (value string, err error) { 31 | cfg.logger.debug(fmt.Sprintf("Try to get value by `%s`", column)) 32 | 33 | value, ok := result.data[column] 34 | if !ok { 35 | err = fmt.Errorf("can't get value by `%s`", column) 36 | 37 | cfg.logger.error(fmt.Sprintf("Catch error %s", err.Error())) 38 | 39 | return 40 | } 41 | 42 | cfg.logger.debug(fmt.Sprintf("Success get `%s` = %s", column, value)) 43 | 44 | return 45 | } 46 | 47 | // Bytes returns value of bytes 48 | func (result Result) Bytes(column string) (bytes []byte, err error) { 49 | value, err := result.String(column) 50 | if err != nil { 51 | return 52 | } 53 | 54 | bytes = []byte(value) 55 | 56 | return 57 | } 58 | 59 | func (result Result) getUInt(column string, bitSize int) (ui64 uint64, err error) { 60 | value, err := result.String(column) 61 | if err != nil { 62 | cfg.logger.error(fmt.Sprintf("Catch error %s", err.Error())) 63 | 64 | return 65 | } 66 | 67 | ui64, err = strconv.ParseUint(value, 10, bitSize) 68 | if err != nil { 69 | err = fmt.Errorf("can't convert value %s to uint%d: %s", value, bitSize, err.Error()) 70 | 71 | cfg.logger.error(fmt.Sprintf("Catch error %s", err.Error())) 72 | 73 | return 74 | } 75 | 76 | return 77 | } 78 | 79 | // Bool returns value as bool 80 | func (result Result) Bool(column string) (f bool, err error) { 81 | i, err := result.getUInt(column, 8) 82 | if err != nil { 83 | return 84 | } 85 | 86 | return i == 1, nil 87 | } 88 | 89 | // UInt8 returns value as uint8 90 | func (result Result) UInt8(column string) (ui8 uint8, err error) { 91 | i, err := result.getUInt(column, 8) 92 | 93 | return uint8(i), err 94 | } 95 | 96 | // UInt16 returns value as uint16 97 | func (result Result) UInt16(column string) (ui16 uint16, err error) { 98 | i, err := result.getUInt(column, 16) 99 | 100 | return uint16(i), err 101 | } 102 | 103 | // UInt32 returns value as uint32 104 | func (result Result) UInt32(column string) (ui32 uint32, err error) { 105 | i, err := result.getUInt(column, 32) 106 | 107 | return uint32(i), err 108 | } 109 | 110 | // UInt64 returns value as uint64 111 | func (result Result) UInt64(column string) (ui64 uint64, err error) { 112 | i, err := result.getUInt(column, 64) 113 | 114 | return uint64(i), err 115 | } 116 | 117 | func (result Result) getInt(column string, bitSize int) (i64 int64, err error) { 118 | value, err := result.String(column) 119 | if err != nil { 120 | cfg.logger.error(fmt.Sprintf("Catch error %s", err.Error())) 121 | 122 | return 0, err 123 | } 124 | 125 | i64, err = strconv.ParseInt(value, 10, bitSize) 126 | if err != nil { 127 | err := fmt.Errorf("can't convert value %s to int%d: %s", value, bitSize, err.Error()) 128 | 129 | cfg.logger.error(fmt.Sprintf("Catch error %s", err.Error())) 130 | 131 | return 0, err 132 | } 133 | 134 | return i64, nil 135 | } 136 | 137 | // Int8 returns value as int8 138 | func (result Result) Int8(column string) (i8 int8, err error) { 139 | i, err := result.getInt(column, 8) 140 | 141 | return int8(i), err 142 | } 143 | 144 | // Int16 returns value as int16 145 | func (result Result) Int16(column string) (i16 int16, err error) { 146 | i, err := result.getInt(column, 16) 147 | 148 | return int16(i), err 149 | } 150 | 151 | // Int32 returns value as int32 152 | func (result Result) Int32(column string) (i32 int32, err error) { 153 | i, err := result.getInt(column, 32) 154 | 155 | return int32(i), err 156 | } 157 | 158 | // Int64 returns value as int64 159 | func (result Result) Int64(column string) (i64 int64, err error) { 160 | i, err := result.getInt(column, 64) 161 | 162 | return int64(i), err 163 | } 164 | 165 | func (result Result) getFloat(column string, bitSize int) (f64 float64, err error) { 166 | value, err := result.String(column) 167 | if err != nil { 168 | cfg.logger.error(fmt.Sprintf("Catch error %s", err.Error())) 169 | 170 | return 0, err 171 | } 172 | 173 | f64, err = strconv.ParseFloat(value, bitSize) 174 | if err != nil { 175 | err := fmt.Errorf("can't convert value %s to float%d: %s", value, bitSize, err.Error()) 176 | 177 | cfg.logger.error(fmt.Sprintf("Catch error %s", err.Error())) 178 | 179 | return 0, err 180 | } 181 | 182 | return f64, nil 183 | } 184 | 185 | // Float32 returns value as float32 186 | func (result Result) Float32(column string) (f32 float32, err error) { 187 | f, err := result.getFloat(column, 32) 188 | 189 | return float32(f), err 190 | } 191 | 192 | // Float64 returns value as float64 193 | func (result Result) Float64(column string) (f64 float64, err error) { 194 | f, err := result.getFloat(column, 64) 195 | 196 | return float64(f), err 197 | } 198 | 199 | // Date returns value as date 200 | func (result Result) Date(column string) (t time.Time, err error) { 201 | value, err := result.String(column) 202 | if err != nil { 203 | cfg.logger.error(fmt.Sprintf("Catch error %s", err.Error())) 204 | 205 | return time.Time{}, err 206 | } 207 | 208 | t, err = time.Parse("2006-01-02", value) 209 | if err != nil { 210 | err := fmt.Errorf("can't convert value %s to date: %s", value, err.Error()) 211 | 212 | cfg.logger.error(fmt.Sprintf("Catch error %s", err.Error())) 213 | 214 | return time.Time{}, err 215 | } 216 | 217 | return t, nil 218 | } 219 | 220 | // DateTime returns value as datetime 221 | func (result Result) DateTime(column string) (t time.Time, err error) { 222 | value, err := result.String(column) 223 | if err != nil { 224 | cfg.logger.error(fmt.Sprintf("Catch error %s", err.Error())) 225 | 226 | return time.Time{}, err 227 | } 228 | 229 | t, err = time.Parse("2006-01-02 15:04:05", value) 230 | if err != nil { 231 | err := fmt.Errorf("can't convert value %s to datetime: %s", value, err.Error()) 232 | 233 | cfg.logger.error(fmt.Sprintf("Catch error %s", err.Error())) 234 | 235 | return time.Time{}, err 236 | } 237 | 238 | return t, nil 239 | } 240 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/leprosus/golang-clickhouse 2 | 3 | go 1.14 4 | 5 | require github.com/leprosus/golang-composer v1.0.0 6 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- 1 | github.com/leprosus/golang-composer v1.0.0 h1:js5QSkdVsg+EGRdTz+qhT0jYVYj7PIxMz+qp9g89bk8= 2 | github.com/leprosus/golang-composer v1.0.0/go.mod h1:x1Uvpa6S78C2LqtDM2h9Uv6ZwzuQmUVXyfE5pzNZmCk= 3 | -------------------------------------------------------------------------------- /limiter.go: -------------------------------------------------------------------------------- 1 | package clickhouse 2 | 3 | import ( 4 | "fmt" 5 | composer "github.com/leprosus/golang-composer" 6 | "sync" 7 | "sync/atomic" 8 | ) 9 | 10 | type Limiter struct { 11 | once sync.Once 12 | 13 | maxRequests uint32 14 | requestsCounter int32 15 | queue chan int32 16 | } 17 | 18 | // MaxRequests sets requests limitation (zero is limitation off) 19 | func (lim *Limiter) MaxRequests(limit int) { 20 | atomic.StoreUint32(&lim.maxRequests, uint32(limit)) 21 | 22 | message := fmt.Sprintf("Set max request pool = %d", limit) 23 | cfg.logger.debug(message) 24 | } 25 | 26 | func (lim *Limiter) initQueue() { 27 | lim.queue = make(chan int32) 28 | 29 | go func() { 30 | for step := range lim.queue { 31 | atomic.AddInt32(&lim.requestsCounter, step) 32 | 33 | if atomic.LoadUint32(&lim.maxRequests) > 0 { 34 | if atomic.LoadUint32(&lim.maxRequests) <= uint32(atomic.LoadInt32(&lim.requestsCounter)) { 35 | composer.GetComposer().Pause() 36 | } else { 37 | composer.GetComposer().Play() 38 | } 39 | } else { 40 | composer.GetComposer().Play() 41 | } 42 | } 43 | }() 44 | } 45 | 46 | func (lim *Limiter) increase() { 47 | lim.once.Do(lim.initQueue) 48 | lim.queue <- 1 49 | } 50 | 51 | func (lim *Limiter) reduce() { 52 | lim.once.Do(lim.initQueue) 53 | lim.queue <- -1 54 | } 55 | 56 | func (lim *Limiter) waitForRest() { 57 | composer.GetComposer().NeedWait() 58 | } 59 | --------------------------------------------------------------------------------