Skip to content

Commit 2ac1687

Browse files
committed
docs: generate sql documentation on orientdb
Signed-off-by: Otavio Santana <[email protected]>
1 parent 0065cca commit 2ac1687

File tree

1 file changed

+18
-1
lines changed
  • jnosql-orientdb/src/main/java/org/eclipse/jnosql/databases/orientdb/mapping

1 file changed

+18
-1
lines changed

jnosql-orientdb/src/main/java/org/eclipse/jnosql/databases/orientdb/mapping/SQL.java

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,28 @@
2020
import java.lang.annotation.Target;
2121

2222
/**
23-
* To a dynamic query on OrientDBCrudRepository and OrientDBCrudRepositoryAsync interfaces.
23+
* Annotation for defining dynamic SQL queries in OrientDB repositories.
24+
* <p>
25+
* This annotation is used on methods within {@link OrientDBCrudRepository} to execute
26+
* custom SQL queries directly on OrientDB.
27+
* </p>
28+
*
29+
* <p>Example usage:</p>
30+
* <pre>
31+
* {@code
32+
* @SQL("SELECT FROM User WHERE age > :age")
33+
* List<User> findUsersByAge(@Param("age") int age);
34+
* }
35+
* </pre>
2436
*/
2537
@Retention(RetentionPolicy.RUNTIME)
2638
@Target(ElementType.METHOD)
2739
public @interface SQL {
2840

41+
/**
42+
* Defines the SQL query to be executed.
43+
*
44+
* @return the SQL query string
45+
*/
2946
String value();
3047
}

0 commit comments

Comments
 (0)