-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathoperation.py
More file actions
1390 lines (1236 loc) · 43.1 KB
/
operation.py
File metadata and controls
1390 lines (1236 loc) · 43.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
from typing import List, Optional, Tuple, Dict, Any, Union
import re
import json
from sqlalchemy import text
from sqlalchemy.orm import Session
from sqlalchemy.ext.asyncio import AsyncSession
from .schema import Message, QueueMetrics
class PGMQOperation:
"""
Static operations for PGMQ that accept user-provided sessions.
All methods are static and require a session to be passed in.
Users are responsible for session management and transaction handling.
"""
# Private helper methods for statement and params generation
@staticmethod
def _get_check_pgmq_ext_statement() -> Tuple[str, Dict[str, Any]]:
"""Get statement and params for checking/creating pgmq extension."""
return "create extension if not exists pgmq cascade;", {}
@staticmethod
def _get_check_pg_partman_ext_statement() -> Tuple[str, Dict[str, Any]]:
"""Get statement and params for checking/creating pg_partman extension."""
return "create extension if not exists pg_partman cascade;", {}
@staticmethod
def _validate_partition_interval(interval: Union[int, str]) -> str:
"""Validate partition interval format.
Args:
interval: Either an integer for numeric partitioning or a string for time-based partitioning
(e.g., '1 day', '1 hour', '7 days')
Returns:
The validated interval as a string
Raises:
ValueError: If the interval format is invalid
"""
if isinstance(interval, int):
if interval <= 0:
raise ValueError("Numeric partition interval must be positive")
return str(interval)
# Check if it's a numeric string
if interval.strip().isdigit():
numeric_value = int(interval.strip())
if numeric_value <= 0:
raise ValueError("Numeric partition interval must be positive")
return str(numeric_value)
# Validate time-based interval format
# Valid PostgreSQL interval formats: '1 day', '7 days', '1 hour', '1 month', etc.
time_pattern = r"^\d+\s+(microsecond|millisecond|second|minute|hour|day|week|month|year)s?$"
if not re.match(time_pattern, interval.strip(), re.IGNORECASE):
raise ValueError(
f"Invalid time-based partition interval: '{interval}'. "
"Expected format: '<number> <unit>' where unit is one of: "
"microsecond, millisecond, second, minute, hour, day, week, month, year"
)
return interval.strip()
@staticmethod
def _get_create_queue_statement(
queue_name: str, unlogged: bool
) -> Tuple[str, Dict[str, Any]]:
"""Get statement and params for create_queue."""
if unlogged:
return "select pgmq.create_unlogged(:queue);", {"queue": queue_name}
else:
return "select pgmq.create(:queue);", {"queue": queue_name}
@staticmethod
def _get_create_partitioned_queue_statement(
queue_name: str, partition_interval: str, retention_interval: str
) -> Tuple[str, Dict[str, Any]]:
"""Get statement and params for create_partitioned_queue."""
return (
"select pgmq.create_partitioned(:queue_name, :partition_interval, :retention_interval);",
{
"queue_name": queue_name,
"partition_interval": partition_interval,
"retention_interval": retention_interval,
},
)
@staticmethod
def _get_validate_queue_name_statement(
queue_name: str,
) -> Tuple[str, Dict[str, Any]]:
"""Get statement and params for validate_queue_name."""
return "select pgmq.validate_queue_name(:queue);", {"queue": queue_name}
@staticmethod
def _get_drop_queue_statement(
queue: str, partitioned: bool
) -> Tuple[str, Dict[str, Any]]:
"""Get statement and params for drop_queue."""
return "select pgmq.drop_queue(:queue, :partitioned);", {
"queue": queue,
"partitioned": partitioned,
}
@staticmethod
def _get_list_queues_statement() -> Tuple[str, Dict[str, Any]]:
"""Get statement and params for list_queues."""
return "select queue_name from pgmq.list_queues();", {}
@staticmethod
def _get_send_statement(
queue_name: str, message: dict, delay: int
) -> Tuple[str, Dict[str, Any]]:
"""Get statement and params for send."""
return (
"select * from pgmq.send(:queue_name, CAST(:message AS jsonb), :delay);",
{
"queue_name": queue_name,
"message": json.dumps(message),
"delay": delay,
},
)
@staticmethod
def _get_send_batch_statement(
queue_name: str, messages: List[dict], delay: int
) -> Tuple[str, Dict[str, Any]]:
"""Get statement and params for send_batch.
Note: This uses PostgreSQL array literal format with escaped quotes.
While not ideal, this approach balances SQL injection protection with
cross-driver compatibility. The escaping is safe as long as:
1. Input is a List[dict] (enforced by type hints)
2. json.dumps produces valid JSON (guaranteed for dict inputs)
3. Users do not pass pre-serialized JSON strings as dict values
A more robust solution would use SQLAlchemy's array types or driver-specific
array adaptation, but that would sacrifice cross-driver compatibility.
"""
# Convert list of dicts to array of jsonb strings
# Need to escape quotes for PostgreSQL array literal format
jsonb_strings = [json.dumps(msg).replace('"', '\\"') for msg in messages]
array_literal = "{" + ",".join(f'"{js}"' for js in jsonb_strings) + "}"
return (
"select * from pgmq.send_batch(:queue_name, CAST(:messages AS jsonb[]), :delay);",
{
"queue_name": queue_name,
"messages": array_literal,
"delay": delay,
},
)
@staticmethod
def _get_read_statement(queue_name: str, vt: int) -> Tuple[str, Dict[str, Any]]:
"""Get statement and params for read."""
return "select * from pgmq.read(:queue_name,:vt,1);", {
"queue_name": queue_name,
"vt": vt,
}
@staticmethod
def _get_read_batch_statement(
queue_name: str, vt: int, batch_size: int
) -> Tuple[str, Dict[str, Any]]:
"""Get statement and params for read_batch."""
return (
"select * from pgmq.read(:queue_name,:vt,:batch_size);",
{"queue_name": queue_name, "vt": vt, "batch_size": batch_size},
)
@staticmethod
def _get_read_with_poll_statement(
queue_name: str, vt: int, qty: int, max_poll_seconds: int, poll_interval_ms: int
) -> Tuple[str, Dict[str, Any]]:
"""Get statement and params for read_with_poll."""
return (
"select * from pgmq.read_with_poll(:queue_name,:vt,:qty,:max_poll_seconds,:poll_interval_ms);",
{
"queue_name": queue_name,
"vt": vt,
"qty": qty,
"max_poll_seconds": max_poll_seconds,
"poll_interval_ms": poll_interval_ms,
},
)
@staticmethod
def _get_set_vt_statement(
queue_name: str, msg_id: int, vt: int
) -> Tuple[str, Dict[str, Any]]:
"""Get statement and params for set_vt."""
return (
"select * from pgmq.set_vt(:queue_name, :msg_id, :vt);",
{"queue_name": queue_name, "msg_id": msg_id, "vt": vt},
)
@staticmethod
def _get_pop_statement(queue_name: str) -> Tuple[str, Dict[str, Any]]:
"""Get statement and params for pop."""
return "select * from pgmq.pop(:queue_name);", {"queue_name": queue_name}
@staticmethod
def _get_delete_statement(
queue_name: str, msg_id: int
) -> Tuple[str, Dict[str, Any]]:
"""Get statement and params for delete."""
return "select pgmq.delete(:queue_name, :msg_id);", {
"queue_name": queue_name,
"msg_id": msg_id,
}
@staticmethod
def _get_delete_batch_statement(
queue_name: str, msg_ids: List[int]
) -> Tuple[str, Dict[str, Any]]:
"""Get statement and params for delete_batch."""
return (
"select msg_id from unnest(CAST(:msg_ids AS bigint[])) as msg_id where pgmq.delete(:queue_name, msg_id);",
{"queue_name": queue_name, "msg_ids": msg_ids},
)
@staticmethod
def _get_archive_statement(
queue_name: str, msg_id: int
) -> Tuple[str, Dict[str, Any]]:
"""Get statement and params for archive."""
return "select pgmq.archive(:queue_name, :msg_id);", {
"queue_name": queue_name,
"msg_id": msg_id,
}
@staticmethod
def _get_archive_batch_statement(
queue_name: str, msg_ids: List[int]
) -> Tuple[str, Dict[str, Any]]:
"""Get statement and params for archive_batch."""
return (
"select msg_id from unnest(CAST(:msg_ids AS bigint[])) as msg_id where pgmq.archive(:queue_name, msg_id);",
{"queue_name": queue_name, "msg_ids": msg_ids},
)
@staticmethod
def _get_purge_statement(queue_name: str) -> Tuple[str, Dict[str, Any]]:
"""Get statement and params for purge."""
return "select pgmq.purge_queue(:queue_name);", {"queue_name": queue_name}
@staticmethod
def _get_metrics_statement(queue_name: str) -> Tuple[str, Dict[str, Any]]:
"""Get statement and params for metrics."""
return "select * from pgmq.metrics(:queue_name);", {"queue_name": queue_name}
@staticmethod
def _get_metrics_all_statement() -> Tuple[str, Dict[str, Any]]:
"""Get statement and params for metrics_all."""
return "select * from pgmq.metrics_all();", {}
# Public methods
@staticmethod
def check_pgmq_ext(
*,
session: Session,
commit: bool = True,
) -> None:
"""Check if pgmq extension exists and create it if not.
Args:
session: SQLAlchemy session.
commit: Whether to commit the transaction.
"""
stmt, params = PGMQOperation._get_check_pgmq_ext_statement()
session.execute(text(stmt), params)
if commit:
session.commit()
@staticmethod
async def check_pgmq_ext_async(
*,
session: AsyncSession,
commit: bool = True,
) -> None:
"""Check if pgmq extension exists and create it if not (async).
Args:
session: Async SQLAlchemy session.
commit: Whether to commit the transaction.
"""
stmt, params = PGMQOperation._get_check_pgmq_ext_statement()
await session.execute(text(stmt), params)
if commit:
await session.commit()
@staticmethod
def check_pg_partman_ext(
*,
session: Session,
commit: bool = True,
) -> None:
"""Check if pg_partman extension exists and create it if not.
Args:
session: SQLAlchemy session.
commit: Whether to commit the transaction.
"""
stmt, params = PGMQOperation._get_check_pg_partman_ext_statement()
session.execute(text(stmt), params)
if commit:
session.commit()
@staticmethod
async def check_pg_partman_ext_async(
*,
session: AsyncSession,
commit: bool = True,
) -> None:
"""Check if pg_partman extension exists and create it if not (async).
Args:
session: Async SQLAlchemy session.
commit: Whether to commit the transaction.
"""
stmt, params = PGMQOperation._get_check_pg_partman_ext_statement()
await session.execute(text(stmt), params)
if commit:
await session.commit()
@staticmethod
def create_queue(
queue_name: str,
unlogged: bool = False,
*,
session: Session,
commit: bool = True,
) -> None:
"""Create a new queue.
Args:
queue_name: The name of the queue.
unlogged: If True, creates an unlogged table.
session: SQLAlchemy session.
commit: Whether to commit the transaction.
"""
stmt, params = PGMQOperation._get_create_queue_statement(queue_name, unlogged)
session.execute(text(stmt), params)
if commit:
session.commit()
@staticmethod
async def create_queue_async(
queue_name: str,
unlogged: bool = False,
*,
session: AsyncSession,
commit: bool = True,
) -> None:
"""Create a new queue asynchronously.
Args:
queue_name: The name of the queue.
unlogged: If True, creates an unlogged table.
session: Async SQLAlchemy session.
commit: Whether to commit the transaction.
"""
stmt, params = PGMQOperation._get_create_queue_statement(queue_name, unlogged)
await session.execute(text(stmt), params)
if commit:
await session.commit()
@staticmethod
def create_partitioned_queue(
queue_name: str,
partition_interval: str,
retention_interval: str,
*,
session: Session,
commit: bool = True,
) -> None:
"""Create a new partitioned queue.
Args:
queue_name: The name of the queue.
partition_interval: Partition interval as string.
retention_interval: Retention interval as string.
session: SQLAlchemy session.
commit: Whether to commit the transaction.
"""
# Validate partition intervals
partition_interval = PGMQOperation._validate_partition_interval(
partition_interval
)
retention_interval = PGMQOperation._validate_partition_interval(
retention_interval
)
stmt, params = PGMQOperation._get_create_partitioned_queue_statement(
queue_name, partition_interval, retention_interval
)
session.execute(text(stmt), params)
if commit:
session.commit()
@staticmethod
async def create_partitioned_queue_async(
queue_name: str,
partition_interval: str,
retention_interval: str,
*,
session: AsyncSession,
commit: bool = True,
) -> None:
"""Create a new partitioned queue asynchronously.
Args:
queue_name: The name of the queue.
partition_interval: Partition interval as string.
retention_interval: Retention interval as string.
session: Async SQLAlchemy session.
commit: Whether to commit the transaction.
"""
# Validate partition intervals
partition_interval = PGMQOperation._validate_partition_interval(
partition_interval
)
retention_interval = PGMQOperation._validate_partition_interval(
retention_interval
)
stmt, params = PGMQOperation._get_create_partitioned_queue_statement(
queue_name, partition_interval, retention_interval
)
await session.execute(text(stmt), params)
if commit:
await session.commit()
@staticmethod
def validate_queue_name(
queue_name: str,
*,
session: Session,
commit: bool = True,
) -> None:
"""Validate the length of a queue name.
Args:
queue_name: The name of the queue.
session: SQLAlchemy session.
commit: Whether to commit the transaction.
"""
stmt, params = PGMQOperation._get_validate_queue_name_statement(queue_name)
session.execute(text(stmt), params)
if commit:
session.commit()
@staticmethod
async def validate_queue_name_async(
queue_name: str,
*,
session: AsyncSession,
commit: bool = True,
) -> None:
"""Validate the length of a queue name asynchronously.
Args:
queue_name: The name of the queue.
session: Async SQLAlchemy session.
commit: Whether to commit the transaction.
"""
stmt, params = PGMQOperation._get_validate_queue_name_statement(queue_name)
await session.execute(text(stmt), params)
if commit:
await session.commit()
@staticmethod
def drop_queue(
queue: str,
partitioned: bool = False,
*,
session: Session,
commit: bool = True,
) -> bool:
"""Drop a queue.
Args:
queue: The name of the queue.
partitioned: Whether the queue is partitioned.
session: SQLAlchemy session.
commit: Whether to commit the transaction.
Returns:
True if the queue was dropped successfully.
"""
stmt, params = PGMQOperation._get_drop_queue_statement(queue, partitioned)
row = session.execute(text(stmt), params).fetchone()
if commit:
session.commit()
return row[0]
@staticmethod
async def drop_queue_async(
queue: str,
partitioned: bool = False,
*,
session: AsyncSession,
commit: bool = True,
) -> bool:
"""Drop a queue asynchronously.
Args:
queue: The name of the queue.
partitioned: Whether the queue is partitioned.
session: Async SQLAlchemy session.
commit: Whether to commit the transaction.
Returns:
True if the queue was dropped successfully.
"""
stmt, params = PGMQOperation._get_drop_queue_statement(queue, partitioned)
row = (await session.execute(text(stmt), params)).fetchone()
if commit:
await session.commit()
return row[0]
@staticmethod
def list_queues(
*,
session: Session,
commit: bool = True,
) -> List[str]:
"""List all queues.
Args:
session: SQLAlchemy session.
commit: Whether to commit the transaction.
Returns:
List of queue names.
"""
stmt, params = PGMQOperation._get_list_queues_statement()
rows = session.execute(text(stmt), params).fetchall()
if commit:
session.commit()
return [row[0] for row in rows]
@staticmethod
async def list_queues_async(
*,
session: AsyncSession,
commit: bool = True,
) -> List[str]:
"""List all queues asynchronously.
Args:
session: Async SQLAlchemy session.
commit: Whether to commit the transaction.
Returns:
List of queue names.
"""
stmt, params = PGMQOperation._get_list_queues_statement()
rows = (await session.execute(text(stmt), params)).fetchall()
if commit:
await session.commit()
return [row[0] for row in rows]
@staticmethod
def send(
queue_name: str,
message: dict,
delay: int = 0,
*,
session: Session,
commit: bool = True,
) -> int:
"""Send a message to a queue.
Args:
queue_name: The name of the queue.
message: The message as a dictionary.
delay: Delay in seconds before the message becomes visible.
session: SQLAlchemy session.
commit: Whether to commit the transaction.
Returns:
The message ID.
"""
stmt, params = PGMQOperation._get_send_statement(queue_name, message, delay)
row = session.execute(text(stmt), params).fetchone()
if commit:
session.commit()
return row[0]
@staticmethod
async def send_async(
queue_name: str,
message: dict,
delay: int = 0,
*,
session: AsyncSession,
commit: bool = True,
) -> int:
"""Send a message to a queue asynchronously.
Args:
queue_name: The name of the queue.
message: The message as a dictionary.
delay: Delay in seconds before the message becomes visible.
session: Async SQLAlchemy session.
commit: Whether to commit the transaction.
Returns:
The message ID.
"""
stmt, params = PGMQOperation._get_send_statement(queue_name, message, delay)
row = (await session.execute(text(stmt), params)).fetchone()
if commit:
await session.commit()
return row[0]
@staticmethod
def send_batch(
queue_name: str,
messages: List[dict],
delay: int = 0,
*,
session: Session,
commit: bool = True,
) -> List[int]:
"""Send a batch of messages to a queue.
Args:
queue_name: The name of the queue.
messages: The messages as a list of dictionaries.
delay: Delay in seconds before the messages become visible.
session: SQLAlchemy session.
commit: Whether to commit the transaction.
Returns:
List of message IDs.
"""
stmt, params = PGMQOperation._get_send_batch_statement(queue_name, messages, delay)
rows = session.execute(text(stmt), params).fetchall()
if commit:
session.commit()
return [row[0] for row in rows]
@staticmethod
async def send_batch_async(
queue_name: str,
messages: List[dict],
delay: int = 0,
*,
session: AsyncSession,
commit: bool = True,
) -> List[int]:
"""Send a batch of messages to a queue asynchronously.
Args:
queue_name: The name of the queue.
messages: The messages as a list of dictionaries.
delay: Delay in seconds before the messages become visible.
session: Async SQLAlchemy session.
commit: Whether to commit the transaction.
Returns:
List of message IDs.
"""
stmt, params = PGMQOperation._get_send_batch_statement(queue_name, messages, delay)
rows = (await session.execute(text(stmt), params)).fetchall()
if commit:
await session.commit()
return [row[0] for row in rows]
@staticmethod
def read(
queue_name: str,
vt: int,
*,
session: Session,
commit: bool = True,
) -> Optional[Message]:
"""Read a message from the queue.
Args:
queue_name: The name of the queue.
vt: Visibility timeout in seconds.
session: SQLAlchemy session.
commit: Whether to commit the transaction.
Returns:
Message or None if the queue is empty.
"""
stmt, params = PGMQOperation._get_read_statement(queue_name, vt)
row = session.execute(text(stmt), params).fetchone()
if commit:
session.commit()
if row is None:
return None
return Message(
msg_id=row[0], read_ct=row[1], enqueued_at=row[2], vt=row[3], message=row[4]
)
@staticmethod
async def read_async(
queue_name: str,
vt: int,
*,
session: AsyncSession,
commit: bool = True,
) -> Optional[Message]:
"""Read a message from the queue asynchronously.
Args:
queue_name: The name of the queue.
vt: Visibility timeout in seconds.
session: Async SQLAlchemy session.
commit: Whether to commit the transaction.
Returns:
Message or None if the queue is empty.
"""
stmt, params = PGMQOperation._get_read_statement(queue_name, vt)
row = (await session.execute(text(stmt), params)).fetchone()
if commit:
await session.commit()
if row is None:
return None
return Message(
msg_id=row[0], read_ct=row[1], enqueued_at=row[2], vt=row[3], message=row[4]
)
@staticmethod
def read_batch(
queue_name: str,
vt: int,
batch_size: int = 1,
*,
session: Session,
commit: bool = True,
) -> Optional[List[Message]]:
"""Read a batch of messages from the queue.
Args:
queue_name: The name of the queue.
vt: Visibility timeout in seconds.
batch_size: Number of messages to read.
session: SQLAlchemy session.
commit: Whether to commit the transaction.
Returns:
List of messages or None if the queue is empty.
"""
stmt, params = PGMQOperation._get_read_batch_statement(
queue_name, vt, batch_size
)
rows = session.execute(text(stmt), params).fetchall()
if commit:
session.commit()
if not rows:
return None
return [
Message(
msg_id=row[0],
read_ct=row[1],
enqueued_at=row[2],
vt=row[3],
message=row[4],
)
for row in rows
]
@staticmethod
async def read_batch_async(
queue_name: str,
vt: int,
batch_size: int = 1,
*,
session: AsyncSession,
commit: bool = True,
) -> Optional[List[Message]]:
"""Read a batch of messages from the queue asynchronously.
Args:
queue_name: The name of the queue.
vt: Visibility timeout in seconds.
batch_size: Number of messages to read.
session: Async SQLAlchemy session.
commit: Whether to commit the transaction.
Returns:
List of messages or None if the queue is empty.
"""
stmt, params = PGMQOperation._get_read_batch_statement(
queue_name, vt, batch_size
)
rows = (await session.execute(text(stmt), params)).fetchall()
if commit:
await session.commit()
if not rows:
return None
return [
Message(
msg_id=row[0],
read_ct=row[1],
enqueued_at=row[2],
vt=row[3],
message=row[4],
)
for row in rows
]
@staticmethod
def read_with_poll(
queue_name: str,
vt: int,
qty: int = 1,
max_poll_seconds: int = 5,
poll_interval_ms: int = 100,
*,
session: Session,
commit: bool = True,
) -> Optional[List[Message]]:
"""Read messages from a queue with polling.
Args:
queue_name: The name of the queue.
vt: Visibility timeout in seconds.
qty: Number of messages to read.
max_poll_seconds: Maximum number of seconds to poll.
poll_interval_ms: Interval in milliseconds to poll.
session: SQLAlchemy session.
commit: Whether to commit the transaction.
Returns:
List of messages or None if the queue is empty.
"""
stmt, params = PGMQOperation._get_read_with_poll_statement(
queue_name, vt, qty, max_poll_seconds, poll_interval_ms
)
rows = session.execute(text(stmt), params).fetchall()
if commit:
session.commit()
if not rows:
return None
return [
Message(
msg_id=row[0],
read_ct=row[1],
enqueued_at=row[2],
vt=row[3],
message=row[4],
)
for row in rows
]
@staticmethod
async def read_with_poll_async(
queue_name: str,
vt: int,
qty: int = 1,
max_poll_seconds: int = 5,
poll_interval_ms: int = 100,
*,
session: AsyncSession,
commit: bool = True,
) -> Optional[List[Message]]:
"""Read messages from a queue with polling asynchronously.
Args:
queue_name: The name of the queue.
vt: Visibility timeout in seconds.
qty: Number of messages to read.
max_poll_seconds: Maximum number of seconds to poll.
poll_interval_ms: Interval in milliseconds to poll.
session: Async SQLAlchemy session.
commit: Whether to commit the transaction.
Returns:
List of messages or None if the queue is empty.
"""
stmt, params = PGMQOperation._get_read_with_poll_statement(
queue_name, vt, qty, max_poll_seconds, poll_interval_ms
)
rows = (await session.execute(text(stmt), params)).fetchall()
if commit:
await session.commit()
if not rows:
return None
return [
Message(
msg_id=row[0],
read_ct=row[1],
enqueued_at=row[2],
vt=row[3],
message=row[4],
)
for row in rows
]
@staticmethod
def set_vt(
queue_name: str,
msg_id: int,
vt: int,
*,
session: Session,
commit: bool = True,
) -> Optional[Message]:
"""Set the visibility timeout for a message.
Args:
queue_name: The name of the queue.
msg_id: The message ID.
vt: Visibility timeout in seconds.
session: SQLAlchemy session.
commit: Whether to commit the transaction.
Returns:
Message or None if the message does not exist.
"""
stmt, params = PGMQOperation._get_set_vt_statement(queue_name, msg_id, vt)
row = session.execute(text(stmt), params).fetchone()
if commit:
session.commit()
if row is None:
return None
return Message(
msg_id=row[0], read_ct=row[1], enqueued_at=row[2], vt=row[3], message=row[4]
)
@staticmethod
async def set_vt_async(
queue_name: str,
msg_id: int,
vt: int,
*,
session: AsyncSession,
commit: bool = True,
) -> Optional[Message]:
"""Set the visibility timeout for a message asynchronously.
Args:
queue_name: The name of the queue.
msg_id: The message ID.
vt: Visibility timeout in seconds.
session: Async SQLAlchemy session.
commit: Whether to commit the transaction.
Returns:
Message or None if the message does not exist.
"""
stmt, params = PGMQOperation._get_set_vt_statement(queue_name, msg_id, vt)
row = (await session.execute(text(stmt), params)).fetchone()
if commit:
await session.commit()
if row is None:
return None
return Message(
msg_id=row[0], read_ct=row[1], enqueued_at=row[2], vt=row[3], message=row[4]
)
@staticmethod
def pop(
queue_name: str,
*,
session: Session,
commit: bool = True,
) -> Optional[Message]:
"""Read and delete a message from the queue.
Args:
queue_name: The name of the queue.
session: SQLAlchemy session.
commit: Whether to commit the transaction.
Returns:
Message or None if the queue is empty.
"""
stmt, params = PGMQOperation._get_pop_statement(queue_name)
row = session.execute(text(stmt), params).fetchone()
if commit:
session.commit()
if row is None:
return None
return Message(
msg_id=row[0], read_ct=row[1], enqueued_at=row[2], vt=row[3], message=row[4]
)
@staticmethod
async def pop_async(
queue_name: str,
*,
session: AsyncSession,
commit: bool = True,
) -> Optional[Message]:
"""Read and delete a message from the queue asynchronously.