Skip to content

Commit 480a0d6

Browse files
committed
docs: generate orientdb repository
Signed-off-by: Otavio Santana <[email protected]>
1 parent 2ac1687 commit 480a0d6

File tree

1 file changed

+22
-3
lines changed

1 file changed

+22
-3
lines changed

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

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,29 @@
1818
import org.eclipse.jnosql.mapping.NoSQLRepository;
1919

2020
/**
21-
* The OrientDB {@link NoSQLRepository}
21+
* A repository interface for OrientDB that extends {@link NoSQLRepository}.
22+
* <p>
23+
* This interface allows interaction with OrientDB as a document-oriented NoSQL database,
24+
* supporting standard CRUD operations and custom queries using the {@link SQL} annotation.
25+
* </p>
2226
*
23-
* @param <T> the entity type
24-
* @param <K> the entity id type
27+
* <p>Example usage:</p>
28+
* <pre>
29+
* {@code
30+
* @Repository
31+
* public interface UserRepository extends OrientDBCrudRepository<User, String> {
32+
*
33+
* @SQL("SELECT FROM User WHERE age > :age")
34+
* List<User> findUsersByAge(@Param("age") int age);
35+
*
36+
* @SQL("SELECT FROM User WHERE name = :name")
37+
* List<User> findByName(@Param("name") String name);
38+
* }
39+
* }
40+
* </pre>
41+
*
42+
* @param <T> the entity type
43+
* @param <K> the entity ID type
2544
*/
2645
public interface OrientDBCrudRepository<T, K> extends NoSQLRepository<T, K> {
2746
}

0 commit comments

Comments
 (0)