Add SpEL support for `@Table`, `@Column` and `@MappedCollection` #1461

kurtn718 · 2023-03-24T19:19:05Z

If SpEl expressions are specified in the @table or @column annotation, they will be evaluated and the output will be sanitized to prevent SQL Injections.

The default sanitization only allows digits, alphabetic characters, and _ character. (i.e. [0-9, a-z, A-Z, _])

Closes #1325

If SpEl expressions are specified in the @table or @column annotation, they will be evaluated and the output will be sanitized to prevent SQL Injections. The default sanitization only allows digits, alphabetic characters, and _ character. (i.e. [0-9, a-z, A-Z, _]) Closes #1325

… inject a custom sanitizer in the RelationMappingContext and JdbcMappingContext classes.

Reuse existing EvaluationContextProvider infrastructure and static parser/parser context instances. Parse expressions early. Update Javadoc to reflect SpEL support. Reformat code to use tabs instead of spaces. Rename types for consistency. Rename SpelExpressionResultSanitizer to SqlIdentifierSanitizer to express its intended usage.

mp911de · 2023-04-11T13:43:22Z

I applied a round of polishing. Besides some stylistic changes, please make sure to configure your formatter to use tabs instead of spaces. See https://github.com/spring-projects/spring-data-build/blob/main/etc/ide/eclipse-formatting.xml the formatter config we use across our projects.

schauder · 2023-04-17T10:35:41Z

...n/java/org/springframework/data/relational/core/mapping/BasicRelationalPersistentEntity.java

+
+			Table table = getRequiredAnnotation(Table.class);
+
+			// TODO: support expressions for schema


@mp911de can we please not sprinkle TODOs in our code. Those should be either review comments or issue tickets.

@kurtn718 For this one I'd leave it to you, create a ticket from it, or implement the change as part of this ticket.

I'm in favor of supporting SpEL for schema within the scope of this ticket.

Will see what the scope of changes is - and if small add to this ticket.

Just pushed up an update. Adding this was pretty straight-forward.

schauder · 2023-04-17T10:42:31Z

...ng-data-relational/src/main/java/org/springframework/data/relational/core/mapping/Table.java

@@ -38,25 +38,26 @@
 public @interface Table {

 	/**
-	 * The mapping table name.
+	 * The table name. The attribute supports SpEL expressions to dynamically calculate the table name on a per-operation


This is currently not correct, since SQL statements get cached.

We would need to disable the caching or change the JavaDoc comments.

@mp911de What is your opinion on this?

See also: #435

The cache should be updated to consider dynamic table and column names. This should be possible through a corresponding cache key.

Add SpEL support for schema property in @table annotation

If SpEl expressions are specified in the `@Table` or `@Column` annotation, they will be evaluated and the output will be sanitized to prevent SQL Injections. The default sanitization only allows digits, alphabetic characters, and _ character. (i.e. [0-9, a-z, A-Z, _]) Closes #1325 Original pull request: #1461

Reuse existing EvaluationContextProvider infrastructure and static parser/parser context instances. Parse expressions early. Update Javadoc to reflect SpEL support. Reformat code to use tabs instead of spaces. Rename types for consistency. Rename SpelExpressionResultSanitizer to SqlIdentifierSanitizer to express its intended usage. Eagerly initialize entities where applicable. Simplify code. See #1325 Original pull request: #1461

Add SpEL support for schema property in `@Table` annotation See #1325 Original pull request: #1461

See #1325 Original pull request: #1461

mp911de · 2023-05-31T14:02:48Z

That's merged and polished now.

goafabric · 2023-06-30T13:38:16Z

Hello .. I've got a question concerning this ticket
I've been eagerly following that one, to find a lightweight alternative to Hibernates Tenant Resolver
for Multi Schema
By having a spel expression inside the schema part of the Table annotation
I've been using the same approach successfully for spring data mongo for a while now.

And while i can happily report that this works fine for queries / select stetements,
it seems to fail for insert statements.

While the spel expression is always evaluated correctly to e.g. "tenant-0" or "tenant-5",
and always taken into account for the select from queries ...
For "insert into" it will always use the first one "insert into tenant-0" .. maybe there is some kind of caching going on ?

So my question is, are insert operations also supposed to work with schema ?

As an alternative i was also looking into using a NamingStrategy Bean,
unfortunately this always yields to a CachingNamingStrategy that only resolves the Schema once ...

thx in advance

-- cut examples ---

@table(name = "insurance", schema = "#{@tenantIdBean.getPrefix()}")

@component
public class TenantIdBean {
public String getPrefix() {
return "tenant_" + HttpInterceptor.getTenantId();
}
}

schauder · 2023-06-30T13:43:38Z

Yes, statements do get cached. Please create a new ticket for this.

goafabric · 2023-06-30T13:54:14Z

Yes, statements do get cached. Please create a new ticket for this.

thx

kurtn718 requested review from schauder and mp911de March 24, 2023 19:19

spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Mar 24, 2023

mp911de self-assigned this Mar 27, 2023

kurtn718 and others added 4 commits April 11, 2023 15:23

Remove @Autowired for SpelExpressionResultSanitizer. Allow for one to…

95acec9

… inject a custom sanitizer in the RelationMappingContext and JdbcMappingContext classes.

Fix javadoc error

3349032

mp911de force-pushed the issue/1325 branch from 749af6e to 45fbd5c Compare April 11, 2023 13:41

schauder removed their request for review April 12, 2023 06:23

schauder requested changes Apr 17, 2023

View reviewed changes

Add SpEL support for Schema

2d947f8

Add SpEL support for schema property in @table annotation

mp911de changed the title ~~Issue #1325: Add SpEL support for @Table and @Column names~~ Add SpEL support for @Table, @Column and @MappedCollection May 31, 2023

mp911de added type: enhancement A general enhancement and removed status: waiting-for-triage An issue we've not yet triaged labels May 31, 2023

mp911de added this to the 3.2 M1 (2023.1.0) milestone May 31, 2023

mp911de pushed a commit that referenced this pull request May 31, 2023

Add SpEL support for @Table(schema=…).

a73be5a

Add SpEL support for schema property in `@Table` annotation See #1325 Original pull request: #1461

mp911de added a commit that referenced this pull request May 31, 2023

Add expression support for @MappedCollection annotation.

b92586f

See #1325 Original pull request: #1461

mp911de closed this May 31, 2023

mp911de deleted the issue/1325 branch June 1, 2023 08:16

goafabric mentioned this pull request Jun 30, 2023

Remove caching for table, schema and column names using SpEL expressions #1549

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add SpEL support for `@Table`, `@Column` and `@MappedCollection` #1461

Add SpEL support for `@Table`, `@Column` and `@MappedCollection` #1461

kurtn718 commented Mar 24, 2023

mp911de commented Apr 11, 2023

schauder Apr 17, 2023

mp911de Apr 17, 2023

kurtn718 Apr 24, 2023

kurtn718 Apr 26, 2023

schauder Apr 17, 2023

mp911de Apr 17, 2023

mp911de commented May 31, 2023

goafabric commented Jun 30, 2023 •

edited

Loading

schauder commented Jun 30, 2023

goafabric commented Jun 30, 2023


		Table table = getRequiredAnnotation(Table.class);

		// TODO: support expressions for schema

Add SpEL support for @Table, @Column and @MappedCollection #1461

Add SpEL support for @Table, @Column and @MappedCollection #1461

Conversation

kurtn718 commented Mar 24, 2023

mp911de commented Apr 11, 2023

schauder Apr 17, 2023

Choose a reason for hiding this comment

mp911de Apr 17, 2023

Choose a reason for hiding this comment

kurtn718 Apr 24, 2023

Choose a reason for hiding this comment

kurtn718 Apr 26, 2023

Choose a reason for hiding this comment

schauder Apr 17, 2023

Choose a reason for hiding this comment

mp911de Apr 17, 2023

Choose a reason for hiding this comment

mp911de commented May 31, 2023

goafabric commented Jun 30, 2023 • edited Loading

schauder commented Jun 30, 2023

goafabric commented Jun 30, 2023

Add SpEL support for `@Table`, `@Column` and `@MappedCollection` #1461

Add SpEL support for `@Table`, `@Column` and `@MappedCollection` #1461

goafabric commented Jun 30, 2023 •

edited

Loading