{"id":19032731,"url":"https://github.com/joutvhu/spring-dynamic-jdbc","last_synced_at":"2025-04-13T13:13:56.907Z","repository":{"id":65507747,"uuid":"590124998","full_name":"joutvhu/spring-dynamic-jdbc","owner":"joutvhu","description":"The Spring Dynamic JDBC will make it easy to implement dynamic queries with Spring Data JDBC","archived":false,"fork":false,"pushed_at":"2023-07-28T07:00:03.000Z","size":153,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-13T13:13:52.387Z","etag":null,"topics":["annotation","dynamic-queries","jdbc","spring","spring-boot","spring-data-jdbc"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/joutvhu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-01-17T17:57:03.000Z","updated_at":"2025-04-10T16:56:39.000Z","dependencies_parsed_at":"2024-11-08T21:31:13.093Z","dependency_job_id":null,"html_url":"https://github.com/joutvhu/spring-dynamic-jdbc","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joutvhu%2Fspring-dynamic-jdbc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joutvhu%2Fspring-dynamic-jdbc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joutvhu%2Fspring-dynamic-jdbc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joutvhu%2Fspring-dynamic-jdbc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/joutvhu","download_url":"https://codeload.github.com/joutvhu/spring-dynamic-jdbc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248717237,"owners_count":21150389,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["annotation","dynamic-queries","jdbc","spring","spring-boot","spring-data-jdbc"],"created_at":"2024-11-08T21:30:45.157Z","updated_at":"2025-04-13T13:13:56.886Z","avatar_url":"https://github.com/joutvhu.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Spring Dynamic JDBC\n\nThe Spring Dynamic JDBC will make it easy to implement dynamic queries with Spring Data JDBC.\n\n## How to use?\n\n### Install dependency\n\n```groovy\nimplementation 'com.github.joutvhu:spring-dynamic-jdbc:3.0.1'\n```\n\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.github.joutvhu\u003c/groupId\u003e\n    \u003cartifactId\u003espring-dynamic-jdbc\u003c/artifactId\u003e\n    \u003cversion\u003e3.0.1\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n- Please choose the _Spring Dynamic JDBC_ version appropriate with your spring version.\n\n  | Spring Boot version | Spring Dynamic JDBC version |\n  |:----------:|:-------------:|\n  | 2.3.x.RELEASE | 2.0.1 |\n  | 2.4.x | 2.1.1 |\n  | 2.5.x | 2.2.1 |\n  | 2.6.x | 2.3.1 |\n  | 2.7.x | 2.4.1 |\n  | 3.0.x | 3.0.1 |\n\nAlso, you have to choose a [Dynamic Query Template Provider](https://github.com/joutvhu/spring-dynamic-commons#dynamic-query-template-provider) to use,\nthe Dynamic Query Template Provider will decide the style you write dynamic query template.\n\nIn this document, I will use [Spring Dynamic Freemarker](https://github.com/joutvhu/spring-dynamic-freemarker).\n\n```groovy\nimplementation 'com.github.joutvhu:spring-dynamic-freemarker:1.0.0'\n```\n\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.github.joutvhu\u003c/groupId\u003e\n    \u003cartifactId\u003espring-dynamic-freemarker\u003c/artifactId\u003e\n    \u003cversion\u003e1.0.0\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n### Configuration\n\n- First you need to create a bean of `DynamicQueryTemplateProvider`, that depending on which the Dynamic Query Template Provider you are using.\n\n```java\n@Bean\npublic DynamicQueryTemplateProvider dynamicQueryTemplateProvider() {\n    FreemarkerQueryTemplateProvider provider = new FreemarkerQueryTemplateProvider();\n    provider.setTemplateLocation(\"classpath:/query\");\n    provider.setSuffix(\".dsql\");\n    return provider;\n}\n```\n\n- Next, you need to set the jdbc repository's `repositoryFactoryBeanClass` property to `DynamicJdbcRepositoryFactoryBean.class`.\n\n```java\n// Config with annotation\n@EnableJdbcRepositories(repositoryFactoryBeanClass = DynamicJdbcRepositoryFactoryBean.class)\n```\n\n### Dynamic query\n\n- Use annotation @DynamicQuery to define dynamic queries.\n\n```java\npublic interface UserRepository extends CrudRepository\u003cUser, Long\u003e {\n    @DynamicQuery(\n        value = \"select * from USER where FIRST_NAME = :firstName\\n\" +\n            \"\u003c#if lastName?has_content\u003e\\n\" +\n            \"  and LAST_NAME = :lastName\\n\" +\n            \"\u003c/#if\u003e\"\n    )\n    List\u003cUser\u003e findUserByNames(Long firstName, String lastName);\n\n    @Query(value = \"select * from USER where FIRST_NAME = :firstName\")\n    List\u003cUser\u003e findByFirstName(String firstName);\n\n    @DynamicQuery(\n        value = \"select USER_ID from USER\\n\" +\n            \"\u003c#if name??\u003e\\n\" +\n            \"  where concat(FIRST_NAME, ' ', LAST_NAME) like %:name%\\n\" +\n            \"\u003c/#if\u003e\"\n    )\n    List\u003cLong\u003e searchIdsByName(String name);\n\n    @DynamicQuery(\n        value = \"select * from USER\\n\" +\n            \"\u003c#if role??\u003e\\n\" +\n            \"  where ROLE = :role\\n\" +\n            \"\u003c/#if\u003e\"\n    )\n    List\u003cUser\u003e findByRole(String role);\n}\n```\n\n### Load query template files\n\n- If you do not specify the query template on the `@DynamicQuery` annotation.\n  The `DynamicQueryTemplateProvider` will find them from external template files based on the `TemplateLocation` and `Suffix` that you specify in the provider.\n\n- If you don't want to load the template from external template files you can use the following code `provider.setSuffix(null);`.\n\n- Each template will start with a template name definition line. The template name definition line must be start with two dash characters (`--`). The template name will have the following syntax.\n\n  ```\n  queryMethodName\n  ```\n\n  - `queryMethodName` can be provided through field `@DynamicQuery.name`. If `@DynamicQuery.name` is not provided, `queryMethodName` will be `entityName:methodName` where `entityName` is entity class name, `methodName` is query method name\n\n- Query templates (Ex: `resoucers/query/user-query.dsql`) \n\n```sql\n--User:findUserByNames\nselect * from USER where FIRST_NAME = :firstName\n\u003c#if lastName?has_content\u003e\n  and LAST_NAME = :lastName\n\u003c/#if\u003e\n\n-- User:searchIdsByName\nselect USER_ID from USER\n\u003c#if name??\u003e\n  where concat(FIRST_NAME, ' ', LAST_NAME) like %:name%\n\u003c/#if\u003e\n\n-- User:findByRole\nselect * from USER\n\u003c#if role??\u003e\n  where ROLE = :role\n\u003c/#if\u003e\n\n-- User:findByGroup\nselect * from USER\n\u003c#if group.name?starts_with(\"Git\")\u003e\n  where GROUP_ID = :#{#group.id}\n\u003c/#if\u003e\n\n-- get_user_by_username_and_email\nselect * from USER\n\u003c@where\u003e\n  \u003c#if username??\u003e\n    and USERNAME = :username\n  \u003c/#if\u003e\n  \u003c#if email??\u003e\n    and EMAIL = :email\n  \u003c/#if\u003e\n\u003c/@where\u003e\n```\n\n- Now you don't need to specify the query template on `@DynamicQuery` annotation.\n\n```java\npublic interface UserRepository extends CrudRepository\u003cUser, Long\u003e {\n    @DynamicQuery\n    List\u003cUser\u003e findUserByNames(Long firstName, String lastName);\n\n    @Query(value = \"select * from USER where FIRST_NAME = :firstName\")\n    List\u003cUser\u003e findByFirstName(String firstName);\n\n    @DynamicQuery\n    List\u003cLong\u003e searchIdsByName(String name);\n\n    @DynamicQuery\n    List\u003cUser\u003e findByRole(String role);\n\n    @DynamicQuery\n    List\u003cUser\u003e findByGroup(Group group);\n\n    @DynamicQuery(name = \"get_user_by_username_and_email\")\n    List\u003cUser\u003e getUserWithUsernameAndEmail(String username, String email);\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoutvhu%2Fspring-dynamic-jdbc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjoutvhu%2Fspring-dynamic-jdbc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoutvhu%2Fspring-dynamic-jdbc/lists"}