-
Notifications
You must be signed in to change notification settings - Fork 25
/
InsertQuery.java
93 lines (80 loc) · 3.27 KB
/
InsertQuery.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
/*
* Copyright (c) 2019 Otavio Santana and others
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the Eclipse
* Public License v. 2.0 are satisfied: GNU General Public License, version 2
* with the GNU Classpath Exception which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package jakarta.nosql.query;
import jakarta.nosql.ServiceLoaderProvider;
import java.time.Duration;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.ServiceLoader;
import java.util.function.Function;
/**
* Inserting data for an entity is done using an <b>INSERT</b> statement.
*/
public interface InsertQuery extends Query {
/**
* The entity name
* @return the entity
*/
String getEntity();
/**
* This duration set a time for data in an entity to expire. It defines the time to live of an object in a database.
* @return the TTL otherwise {@link Optional#empty()}
*/
Optional<Duration> getTtl();
/**
* The list of changes as conditions. Each condition will use the equals operator, {@link Operator#EQUALS},
* e.g., name = "any name"
* @return the conditions
*/
List<Condition> getConditions();
/**
* Returns the value to insert when the query uses JSON value instead of Conditions.
* In an insert, an operation is not able to use both: {@link InsertQuery#getConditions()} and
* {@link InsertQuery#getValue()}.
* Therefore, execution will use just one operation type.
* @return a {@link JSONQueryValue} or {@link Optional#empty()} when it uses {@link InsertQuery#getConditions()}
*/
Optional<JSONQueryValue> getValue();
/**
* Obtains an instance of {@link InsertQueryProvider} from a text string.
*
* @param query the query
* @return {@link InsertQueryProvider} instance
* @throws NullPointerException when the query is null
* @throws QuerySyntaxException if the text cannot be parsed
* @throws jakarta.nosql.ProviderNotFoundException when the provider is not found
*/
static InsertQuery parse(String query) {
Objects.requireNonNull(query, "query is required");
return ServiceLoaderProvider.get(InsertQueryProvider.class, ()->
ServiceLoader.load(InsertQueryProvider.class)).apply(query);
}
/**
* Returns the {@link InsertQueryProvider} instance
* @return the InsertQueryProvider instance
* @throws jakarta.nosql.ProviderNotFoundException when the provider is not found
*/
static InsertQueryProvider getProvider() {
return ServiceLoaderProvider.get(InsertQueryProvider.class, ()->
ServiceLoader.load(InsertQueryProvider.class));
}
/**
* A provider to {@link InsertQuery}, this provider converts text into {@link InsertQuery}
*/
interface InsertQueryProvider extends Function<String, InsertQuery> {
}
}