Skip to content

Commit

Permalink
Ignore Explain Plan Queries (PAYINP-2326)
Browse files Browse the repository at this point in the history
Configure the default table access statistics to ignore explain plan queries, via the default query parser interceptor.

Explain plan queries don't really access the tables, so there shouldn't really be a need to include these queries in the statistics. Additionally, JSQLParser fails to parse them, which causes warnings to be emitted in services using the library.
  • Loading branch information
mscott-tw committed Feb 14, 2024
1 parent e841df2 commit 093bc0b
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 2 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres
to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [2.16.0] - 2024-02-14

### Changed

* Ignore explain plan queries, which are generated by tw-reliable-jdbc, as they do not really access the tables and JSQLParser fails to parse them


## [2.15.0] - 2024-01-25

* Upgrading libraries, mainly the JSqlParser, to support more queries out of the box.
Expand Down
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
@@ -1 +1 @@
version=2.15.0
version=2.16.0
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

public class DefaultTasQueryParsingInterceptor implements TasQueryParsingInterceptor {

private static Pattern PG_SET_PATTERN = Pattern.compile("(?is)SET\\s+[a-z_]*\\s+TO\\s+.*");
private static final Pattern PG_SET_PATTERN = Pattern.compile("(?is)SET\\s+[a-z_]*\\s+TO\\s+.*|EXPLAIN\\s+.*");

@Override
public InterceptResult intercept(String sql) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,15 @@ void testJSqlParser() {
testCases.add(new TestCase("set idle_in_transaction_session_timeout to '600000'",
List.of()));

testCases.add(new TestCase("EXPLAIN FORMAT=JSON select * from fx.request where id = 1",
List.of()));
testCases.add(new TestCase("explain FORMAT=JSON select * from fx.request where id = 1",
List.of()));
testCases.add(new TestCase("EXPLAIN (FORMAT JSON) select * from fx.request where id = 1",
List.of()));
testCases.add(new TestCase("explain (FORMAT JSON) select * from fx.request where id = 1",
List.of()));

testCases.add(new TestCase("insert into fin_unique_tw_task_key(task_id,key_hash,key) values(?, ?, ?) on conflict (key_hash, key) do nothing",
List.of("fin_unique_tw_task_key")));

Expand Down

0 comments on commit 093bc0b

Please sign in to comment.