Skip to content

Commit

Permalink
Add deprecation decorations
Browse files Browse the repository at this point in the history
  • Loading branch information
ptpaterson committed Oct 11, 2024
1 parent 87fad9f commit be766e4
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,13 @@
*
* <p>Relies on {@link java.net.http.HttpClient}
* for the underlying implementation.</p>
*
* @deprecated
* Fauna is decommissioning FQL v4 on June 30, 2025. This driver is not compatible with FQL v10.
* Fauna accounts created after August 21, 2024 must use FQL v10.
* Ensure you migrate existing projects to the official v10 driver by the v4 EOL date: https://github.com/fauna/fauna-jvm.
*/
@Deprecated(since = "4.5.1")
public class Connection {

private static final String API_VERSION = "4";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,13 @@
* </pre>
*
* @see com.faunadb.client.query.Language
*
* @deprecated
* Fauna is decommissioning FQL v4 on June 30, 2025. This driver is not compatible with FQL v10.
* Fauna accounts created after August 21, 2024 must use FQL v10.
* Ensure you migrate existing projects to the official v10 driver by the v4 EOL date: https://github.com/fauna/fauna-jvm.
*/
@Deprecated(since = "4.5.1")
public class FaunaClient {

/**
Expand Down
34 changes: 33 additions & 1 deletion faunadb-scala/src/main/scala/faunadb/FaunaClient.scala
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,19 @@ import scala.compat.java8.OptionConverters._
import scala.concurrent.duration.FiniteDuration
import scala.concurrent.{ExecutionContext, Future}

/** Companion object to the FaunaClient class. */
/**
* Companion object to the FaunaClient class.
*
* @deprecated
* Fauna is decommissioning FQL v4 on June 30, 2025. This driver is not compatible with FQL v10.
* Fauna accounts created after August 21, 2024 must use FQL v10.
* Ensure you migrate existing projects to the official v10 driver by the v4 EOL date: https://github.com/fauna/fauna-jvm.
*/
@deprecated("Fauna is decommissioning FQL v4 on June 30, 2025. This driver is not compatible with FQL v10. " +
"Fauna accounts created after August 21, 2024 must use FQL v10. " +
"Ensure you migrate existing projects to the official v10 driver by the v4 EOL date: https://github.com/fauna/fauna-jvm.",
"4.5.1"
)
object FaunaClient {

// singleton ObjectMapper for all clients
Expand All @@ -43,7 +55,17 @@ object FaunaClient {
* milliseconds precision. If not provided, a default timeout value is set on the server side.
* @param userAgent A value used for the User-Agent HTTP header.
* @return A configured FaunaClient instance.
*
* @deprecated
* Fauna is decommissioning FQL v4 on June 30, 2025. This driver is not compatible with FQL v10.
* Fauna accounts created after August 21, 2024 must use FQL v10.
* Ensure you migrate existing projects to the official v10 driver by the v4 EOL date: https://github.com/fauna/fauna-jvm.
*/
@deprecated("Fauna is decommissioning FQL v4 on June 30, 2025. This driver is not compatible with FQL v10. " +
"Fauna accounts created after August 21, 2024 must use FQL v10. " +
"Ensure you migrate existing projects to the official v10 driver by the v4 EOL date: https://github.com/fauna/fauna-jvm.",
"4.5.1"
)
def apply(
secret: String = null,
endpoint: String = null,
Expand Down Expand Up @@ -105,7 +127,17 @@ object FaunaClient {
* }}}
*
* @constructor create a new client with a configured [[com.faunadb.common.Connection]].
*
* @deprecated
* Fauna is decommissioning FQL v4 on June 30, 2025. This driver is not compatible with FQL v10.
* Fauna accounts created after August 21, 2024 must use FQL v10.
* Ensure you migrate existing projects to the official v10 driver by the v4 EOL date: https://github.com/fauna/fauna-jvm.
*/
@deprecated("Fauna is decommissioning FQL v4 on June 30, 2025. This driver is not compatible with FQL v10. " +
"Fauna accounts created after August 21, 2024 must use FQL v10. " +
"Ensure you migrate existing projects to the official v10 driver by the v4 EOL date: https://github.com/fauna/fauna-jvm.",
"4.5.1"
)
class FaunaClient private (connection: Connection) {

/**
Expand Down
2 changes: 1 addition & 1 deletion project/Settings.scala
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import scoverage.ScoverageSbtPlugin.autoImport._

object Settings {

lazy val driverVersion = "4.5.0"
lazy val driverVersion = "4.5.1"

lazy val scala211 = "2.11.12"
lazy val scala212 = "2.12.14"
Expand Down

0 comments on commit be766e4

Please sign in to comment.