+
+| Scalar Definition |
+Description |
+
+
+
+scalar DateTime
+ @specifiedBy(url:
+ "https://scalars.graphql.org/andimarek/date-time.html"
+ )
+ |
+A RFC-3339 compliant date time scalar that accepts string values like 1996-12-19T16:39:57-08:00 and produces java.time.OffsetDateTime objects at runtime. |
+
+
+
+scalar Date
+ @specifiedBy(url:
+ "https://tools.ietf.org/html/rfc3339"
+ ) |
+A RFC-3339 compliant date scalar that accepts string values like 1996-12-19 and produces java.time.LocalDate objects at runtime. |
+
+
+
+scalar Time
+ @specifiedBy(url:
+ "https://tools.ietf.org/html/rfc3339"
+ )
+ |
+A RFC-3339 compliant time scalar that accepts string values like 16:39:57-08:00 and produces java.time.OffsetTime objects at runtime. |
+
+
+
+scalar LocalTime
+ |
+24-hour clock time string in the format hh:mm:ss.sss or hh:mm:ss if partial seconds is zero and produces java.time.LocalTime objects at runtime. |
+
+
An example declaration in SDL might be:
```graphql
type Customer {
- name: String
- associatedMetaData: JSON
+ birthDay: Date
+ workStartTime: Time
+ bornAt: DateTime
}
type Query {
- customers(filterSyntax: JSON): [Customers]
+ customers(bornAfter: DateTime): [Customers]
}
```
@@ -141,42 +185,73 @@ And example query might look like:
```graphql
query {
- customers(
- filterSyntax: {
- startSpan: "First"
- matchCriteria: { countryCode: "AU", isoCodes: ["27B-34R", "95A-E23"] }
- }
- ) {
- name
- associatedMetaData
+ customers(bornAfter: "1996-12-19T16:39:57-08:00") {
+ birthDay
+ bornAt
}
}
```
-Note : The `JSON` scalar is a simple alias type to the `Object` scalar because often the returned data is a blob of JSON. They are
-all just objects at runtime in graphql-java terms and what network serialisation protocol is up to you. Choose whichever name you think
-adds more semantic readers to your schema consumers.
+## ID Scalars
+
+
+
+| Scalar Definition |
+Description |
+
+
+scalar PositiveInt |
+An Int scalar that MUST be greater than zero. |
+
+
+scalar NegativeInt |
+An Int scalar that MUST be less than zero. |
+
+
+scalar NonPositiveInt |
+An Int scalar that MUST be less than or equal to zero. |
+
+
+scalar NonNegativeInt |
+An Int scalar that MUST be greater than or equal to zero. |
+
+
+scalar PositiveFloat |
+An Float scalar that MUST be greater than zero. |
+
+
+scalar NegativeFloat |
+An Float scalar that MUST be less than zero. |
+
+
+scalar NonPositiveFloat |
+An Float scalar that MUST be less than or equal to zero. |
+
+
+scalar NonNegativeFloat |
+An Float scalar that MUST be greater than or equal to zero. |
+
+
+
+The numeric scalars are derivations of the standard GraphQL `Int` and `Float` scalars that enforce range limits.
An example declaration in SDL might be:
@@ -205,27 +280,56 @@ query {
}
```
-## Regex Scalars
-
-The RegexScalar has a builder where you provide one or more regex patterns that control the acceptable values
-for a new scalar.
-
-You name the scalar and it provides an implementation.
-
-For example, imagine a `phoneNumber` scalar like this :
-
-```java
-
- RegexScalar phoneNumberScalar = ExtendedScalars.newRegexScalar("phoneNumber")
- .addPattern(Pattern.compile("\\([0-9]*\\)[0-9]*"))
- .build()
+## Java Primitives
-```
+