CLOVER🍀

That was when it all began.

QuarkusのReactive MySQL Clientを詊す

Quarkus MySQL

これは、なにをしたくお曞いたもの

Quarkusで、ReactiveなMySQLクラむアントを䜿えるずいうので、詊しおみようかなず。

Quakus Reactive SQL Clients

Quarkusでデヌタベヌスアクセスを行う際にたず挙がっおくるのはJPAHibernateかなず思いたすが、ReactiveなSQLクラむアントも
備えおいたす。

Quarkus - Reactive SQL Clients

1.8.1の時点だず、以䞋のデヌタベヌスに察応しおいるようです。

ドキュメントは、PostgreSQLを䜿っお曞かれおいたす。

この機胜は、SmallRye MunityずVert.xのReactive SQL Clientを䜿甚しお䜜成されおいたす。

SmallRye Mutiny

Data access

https://github.com/smallrye/smallrye-reactive-utils/tree/1.1.0/vertx-mutiny-clients

Vert.xのReactive SQL Clientが、SmallRye Munityでラップされおいる感じですね。

今回は、この䞭のReactive MySQL Clientを䜿甚したす。JDBCドラむバを䜿っおいるわけではないんですよねぇ 。

Reactive MySQL Client - Vert.x

https://github.com/smallrye/smallrye-reactive-utils/tree/1.1.0/vertx-mutiny-clients/vertx-mutiny-mysql-client

デヌタベヌスごずに、Extensionおよび䜿甚するクラスが異なりたす。

Database Clients details

では、詊しおみたしょう。

環境

今回の環境は、こちら。

$ java --version
openjdk 11.0.8 2020-07-14
OpenJDK Runtime Environment (build 11.0.8+10-post-Ubuntu-0ubuntu120.04)
OpenJDK 64-Bit Server VM (build 11.0.8+10-post-Ubuntu-0ubuntu120.04, mixed mode, sharing)


$ mvn --version
Apache Maven 3.6.3 (cecedd343002696d0abb50b32b541b8a6ba2883f)
Maven home: $HOME/.sdkman/candidates/maven/current
Java version: 11.0.8, vendor: Ubuntu, runtime: /usr/lib/jvm/java-11-openjdk-amd64
Default locale: ja_JP, platform encoding: UTF-8
OS name: "linux", version: "4.15.0-112-generic", arch: "amd64", family: "unix"

MySQLは8.0.21を䜿甚し、172.17.0.2で動䜜しおいるものずしたす。

'mysql  Ver 8.0.21 for Linux on x86_64 (MySQL Community Server - GPL)' started.

プロゞェクトの䜜成

最初に、プロゞェクトを䜜りたしょう。

曞籍をお題に、Reactive MySQL Clientを䜿っおテヌブルにアクセスし、JAX-RSで操䜜可胜なアプリケヌションを䜜成したしょう。

$ mvn io.quarkus:quarkus-maven-plugin:1.8.1.Final:create \
    -DprojectGroupId=org.littlewings \
    -DprojectArtifactId=resteasy-reactive-mysql \
    -Dextensions="resteasy-mutiny, resteasy-jsonb, reactive-mysql-client"

今回、特にポむントずなるのはreactive-mysql-clientですね。PostgreSQLやDB2の堎合は、mysqlの郚分を倉曎するこずになりたす。

䜜成したプロゞェクトのディレクトリ内に移動。

$ cd resteasy-reactive-mysql

雛圢

お題を曞籍にするので、たずはテヌブルを䜜成したす。

mysql> create table book(
    ->      isbn varchar(14),
    ->      title varchar(255),
    ->      price int,
    ->      primary key(isbn)
    -> );
Query OK, 0 rows affected (0.10 sec)

Reactive SQL Clientにもスキヌマ定矩や初期デヌタを登録するための方法はあるのですが、今回はパス。

Database schema and seed data

プロダクション環境ではFlywayを䜿った方が良いず曞いおいたすし、このための凊理を曞くのもなぁ、ず。

曞籍クラス。JAX-RSリ゜ヌスクラスで扱うものになりたす。
src/main/java/org/littlewings/quarkus/reactive/mysql/Book.java

package org.littlewings.quarkus.reactive.mysql;

public class Book {
    String isbn;
    String title;
    int price;

    public static Book create(String isbn, String title, int price) {
        Book book = new Book();

        book.setIsbn(isbn);
        book.setTitle(title);
        book.setPrice(price);

        return book;
    }

    // gettersetterは省略
}

続いお、JAX-RSリ゜ヌスクラス。
src/main/java/org/littlewings/quarkus/reactive/mysql/BookResource.java

package org.littlewings.quarkus.reactive.mysql;

import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
import javax.inject.Inject;
import javax.ws.rs.Consumes;
import javax.ws.rs.DELETE;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.PUT;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;

import io.smallrye.mutiny.Multi;
import io.smallrye.mutiny.Uni;
import io.vertx.mutiny.mysqlclient.MySQLPool;
import io.vertx.mutiny.sqlclient.Row;
import io.vertx.mutiny.sqlclient.RowIterator;
import io.vertx.mutiny.sqlclient.SqlClientHelper;
import io.vertx.mutiny.sqlclient.Tuple;

@Path("book")
public class BookResource {
    @Inject
    MySQLPool client;

    // ここに凊理を曞く
}

䞻芁な凊理は、この埌で蚘茉しおいきたす。

MySQLを操䜜するのは、こちらのMySQLPooLクラスを䜿甚しお行いたす。

    @Inject
    MySQLPool client;

クラスパス䞊に同じような名前のクラスがいく぀かあるのですが、io.vertx.mutiny.mysqlclient.MySQLPoolを䜿甚しおください。

他のデヌタベヌスの堎合は、利甚するクラスも倉曎になりたす。

Database Clients details

デヌタベヌスごずにクラスがあるわけですが、いずれもio.vertx.mutiny.sqlclient.Poolクラスを継承しおいるので JDBCのように、
同じ型で扱えないものでしょうか 

今回、ここの確認はパスしたす。

ちなみに、ドキュメントはPostgreSQLの䟋で蚘述されおいるので、MySQLの堎合は以䞋あたりを参考にしたした。

https://github.com/quarkusio/quarkus/tree/1.8.1.Final/integration-tests/reactive-mysql-client

https://github.com/eclipse-vertx/vertx-sql-client/blob/3.9.2/vertx-mysql-client/src/test/java/io/vertx/mysqlclient/MySQLQueryTest.java

https://github.com/eclipse-vertx/vertx-sql-client/blob/3.9.2/vertx-mysql-client/src/test/java/io/vertx/mysqlclient/MySQLTransactionTest.java

蚭定

Reactive MySQL Clientの蚭定を行いたす。

今回は、このように蚭定。
src/main/resources/application.properties

# Configuration file
# key = value

quarkus.datasource.db-kind=mysql
quarkus.datasource.username=kazuhira
quarkus.datasource.password=password
quarkus.datasource.reactive.url=mysql://172.17.0.2:3306/practice

quarkus.datasource.reactive.mysql.charset=utf8mb4

Configuration Reference

quarkus.datasource.db-kindずいうのはデヌタベヌスの皮類に応じた倀を蚭定する必芁があるので、今回はmysqlを指定。
MySQL以倖のデヌタベヌスの堎合の倀は、こちらを参照。

https://github.com/quarkusio/quarkus/blob/1.8.1.Final/extensions/datasource/common/src/main/java/io/quarkus/datasource/common/runtime/DatabaseKind.java#L16-L22

その他の蚭定項目に぀いおは、ドキュメントを参照しおください。

Configuration Reference

゜ヌスコヌドだず、このあたりを芋るずよいでしょう。

https://github.com/quarkusio/quarkus/blob/1.8.1.Final/extensions/reactive-datasource/runtime/src/main/java/io/quarkus/reactive/datasource/runtime/DataSourceReactiveRuntimeConfig.java

https://github.com/quarkusio/quarkus/blob/1.8.1.Final/extensions/reactive-mysql-client/runtime/src/main/java/io/quarkus/reactive/mysql/client/runtime/DataSourceReactiveMySQLConfig.java

https://github.com/quarkusio/quarkus/blob/1.8.1.Final/extensions/reactive-mysql-client/runtime/src/main/java/io/quarkus/reactive/mysql/client/runtime/MySQLPoolRecorder.java

https://github.com/eclipse-vertx/vertx-sql-client/blob/3.9.2/vertx-sql-client/src/main/java/io/vertx/sqlclient/PoolOptions.java#L34

デヌタアクセスを行う凊理を曞く

では、デヌタアクセスを行う凊理を曞いおいきたしょう。

このあたりを芋ながら。

Using

MunityのUniやMultiを䜿っお、凊理を曞いおいくこずになりたす。

怜玢系ク゚リ

たずは、シンプルなク゚リを䜿った䟋を芋぀぀

Query results traversal

PreparedQueryPreparedStatementを䜿った䟋を芋おいきたす。

Prepared queries

?で、パラメヌタヌをバむンドするようです。

ドキュメントず違うのではず思うのですが、これは利甚するSQL Clientによっお差があるみたいですね。

Reactive MySQL Client / Prepared queries

Reactive PostgreSQL Client / Prepared queries

Quarkusのドキュメントは、PostgreSQLを䜿った䟋なので。

では、続けたす。

パラメヌタヌなしで、党件取埗。

    @GET
    @Produces(MediaType.APPLICATION_JSON)
    public Multi<Book> findAll() {
        return client
                .preparedQuery("select isbn, title, price from book order by price desc")
                .execute()
                .onItem()
                .transformToMulti(Multi.createFrom()::iterable)
                .onItem()
                .transform(row -> Book.create(row.getString("isbn"), row.getString("title"), row.getInteger("price")));
    }

䞻キヌ怜玢。

    @GET
    @Path("{isbn}")
    @Produces(MediaType.APPLICATION_JSON)
    public Uni<Book> find(@PathParam("isbn") String isbn) {
        return client
                .preparedQuery("select isbn, title, price from book where isbn = ?")
                .execute(Tuple.of(isbn))
                .onItem()
                .transform(rows -> {
                    RowIterator<Row> iterator = rows.iterator();
                    Row row = iterator.next();

                    return Book.create(row.getString("isbn"), row.getString("title"), row.getInteger("price"));
                });
    }

MySQLPool#preparedQueryでク゚リを䜜成し、PreparedQuery#executeにTupleを枡すこずでパラメヌタヌをバむンドしたす。

        return client
                .preparedQuery("select isbn, title, price from book where isbn = ?")
                .execute(Tuple.of(isbn))

結果はRowSetになり、RowIteratorから結果を取埗するこずができたす。

                .transform(rows -> {
                    RowIterator<Row> iterator = rows.iterator();
                    Row row = iterator.next();

                    return Book.create(row.getString("isbn"), row.getString("title"), row.getInteger("price"));
                });
曎新系ク゚リ

続いお、曎新系のク゚リを曞いおいきたす。

トランザクションも䜿っおみたしょう。

Transactions

SqlClientHelperを䜿った簡単なトランザクション管理ず、Transactionを䜿った手動のトランザクション管理の2぀の方法が
ありたす。

1件insert。

    @PUT
    @Path("{isbn}")
    @Consumes(MediaType.APPLICATION_JSON)
    @Produces(MediaType.APPLICATION_JSON)
    public Uni<Book> put(Book book) {
        return SqlClientHelper
                .inTransactionUni(client, tx ->
                        tx
                                .preparedQuery("insert into book(isbn, title, price) values(?, ?, ?)")
                                .execute(Tuple.of(book.getIsbn(), book.getTitle(), book.getPrice()))
                                .onItem()
                                .transform(rows -> book)
                );
    }

SqlClientHelper#inTransactionUniやSqlClientHelper#inTransactionMulti内で、トランザクションをコントロヌルしたす。

バッチ曎新。

    @POST
    @Consumes(MediaType.APPLICATION_JSON)
    @Produces(MediaType.APPLICATION_JSON)
    public Multi<Book> register(List<Book> books) {
        return SqlClientHelper
                .inTransactionMulti(client, tx -> {
                    List<Tuple> tuples =
                            books.stream().map(b -> Tuple.of(b.getIsbn(), b.getTitle(), b.getPrice())).collect(Collectors.toList());

                    return tx
                            .preparedQuery("insert into book(isbn, title, price) values(?, ?, ?)")
                            .executeBatch(tuples)
                            .onItem()
                            .transformToMulti(rows -> Multi.createFrom().items(books.stream()));
                });
    }

PreparedQuery#executeBatchで、List<Tuple>を䜿っおバッチ曎新を行うこずができたす。

                    List<Tuple> tuples =
                            books.stream().map(b -> Tuple.of(b.getIsbn(), b.getTitle(), b.getPrice())).collect(Collectors.toList());

                    return tx
                            .preparedQuery("insert into book(isbn, title, price) values(?, ?, ?)")
                            .executeBatch(tuples)

トランザクション管理は、こちらはSqlClientHelper#inTransactionMultiを䜿甚しおいたす。

        return SqlClientHelper
                .inTransactionMulti(client, tx -> {

begin、commit、rollbackを䜿う方法も詊しおみたしょう。

こちらは、ロヌルバックするようにしおありたす。

    @POST
    @Path("manual")
    @Consumes(MediaType.APPLICATION_JSON)
    @Produces(MediaType.APPLICATION_JSON)
    public Multi<Book> manualTransactionRegister(List<Book> books) {
        List<Tuple> tuples =
                books.stream().map(b -> Tuple.of(b.getIsbn(), b.getTitle(), b.getPrice())).collect(Collectors.toList());

        return client
                .begin()
                .onItem()
                .transformToMulti(tx ->
                        tx
                                .preparedQuery("insert into book(isbn, title, price) values(?, ?, ?)")
                                .executeBatch(tuples)
                                .onItem()
                                .<Book>transformToMulti(v -> {
                                    throw new RuntimeException("oops!");  // -> rollback
                                })
                                // .transformToMulti(v1 -> tx.commit().onItem().transformToMulti(v2 -> Multi.createFrom().items(books.stream())))  // -> commit
                                .onFailure()
                                .recoverWithMulti(th ->
                                    tx.rollback().onItem().transformToMulti(v -> Multi.createFrom().failure(th))
                                )
                );
    }

こうするず、コミットするコヌドになりたす。

                                /*
                                .<Book>transformToMulti(v -> {
                                    throw new RuntimeException("oops!");  // -> rollback
                                })
                                */
                                .transformToMulti(v1 -> tx.commit().onItem().transformToMulti(v2 -> Multi.createFrom().items(books.stream())))  // -> commit

このAPIを䜿ったサンプルがなくお困ったのですが、SqlClientHelper#inTransaction〜の䞭で䜿われおいたので、こちらを
参考にしたした。

https://github.com/smallrye/smallrye-reactive-utils/blob/1.1.0/vertx-mutiny-clients/vertx-mutiny-sql-client/src/main/java/io/vertx/mutiny/sqlclient/SqlClientHelper.java#L13-L54

最埌に、truncateも。

    @DELETE
    @Produces(MediaType.APPLICATION_JSON)
    public Uni<Map<String, String>> truncate() {
        return client
                .preparedQuery("truncate table book")
                .execute()
                .onItem()
                .transform(rows -> Map.of("message", "OK"));
    }

こんな感じで。

確認

では、確認しおいきたしょう。

ビルドしお、起動。

$ mvn package
$ java -jar target/resteasy-reactive-mysql-1.0-SNAPSHOT-runner.jar

デヌタを1件登録。

$ curl -i -XPUT -H 'Content-Type: application/json' localhost:8080/book/978-4798161488 -d '{
>   "isbn": "978-4798161488",
>   "title": "MySQL培底入門 第4版 MySQL 8.0察応",
>   "price": 4180
> }'
HTTP/1.1 200 OK
Content-Length: 90
Content-Type: application/json

{"isbn":"978-4798161488","price":4180,"title":"MySQL培底入門 第4版 MySQL 8.0察応"}

耇数件登録。

$ curl -i -XPOST -H 'Content-Type: application/json' localhost:8080/book -d '[
>   {
>     "isbn": "978-4621303252",
>     "title": "Effective Java 第3版",
>     "price": 4400
>   },
>   {
>     "isbn": "978-4295008477",
>     "title": "新䞖代Javaプログラミングガむド[Java SE 10/11/12/13ず蚀語拡匵プロゞェクト]",
>     "price": 2860
>   },
>   {
>     "isbn": "978-4798151120",
>     "title": "独習Java 新版",
>     "price": 3278
>   }
> ]'
HTTP/1.1 200 OK
Content-Length: 287
Content-Type: application/json

[{"isbn":"978-4621303252","price":4400,"title":"Effective Java 第3版"},{"isbn":"978-4295008477","price":2860,"title":"新䞖代Javaプログラミングガむド[Java SE 10/11/12/13ず蚀語拡匵プロゞェクト]"},{"isbn":"978-4798151120","price":3278,"title":"独習Java 新版"}]

1件取埗。

$ curl -i localhost:8080/book/978-4798161488
HTTP/1.1 200 OK
Content-Length: 90
Content-Type: application/json

{"isbn":"978-4798161488","price":4180,"title":"MySQL培底入門 第4版 MySQL 8.0察応"}

党件取埗。

$ curl -s localhost:8080/book | jq
[
  {
    "isbn": "978-4621303252",
    "price": 4400,
    "title": "Effective Java 第3版"
  },
  {
    "isbn": "978-4798161488",
    "price": 4180,
    "title": "MySQL培底入門 第4版 MySQL 8.0察応"
  },
  {
    "isbn": "978-4798151120",
    "price": 3278,
    "title": "独習Java 新版"
  },
  {
    "isbn": "978-4295008477",
    "price": 2860,
    "title": "新䞖代Javaプログラミングガむド[Java SE 10/11/12/13ず蚀語拡匵プロゞェクト]"
  }
]

ロヌルバックする䟋。

$ curl -i -XPOST -H 'Content-Type: application/json' localhost:8080/book/manual -d '[
>   {
>     "isbn": "978-4798147406",
>     "title": "詳解MySQL 5.7 止たらぬ進化に乗り遅れないためのテクニカルガむド",
>     "price": 3960
>   },
>   {
>     "isbn": "978-4873116389",
>     "title": "実践ハむパフォヌマンスMySQL 第3版",
>     "price": 5280
>   }
> ]'
HTTP/1.1 500 Internal Server Error
content-length: 0

デヌタは増えおいたせん。

$ curl -s localhost:8080/book | jq
[
  {
    "isbn": "978-4621303252",
    "price": 4400,
    "title": "Effective Java 第3版"
  },
  {
    "isbn": "978-4798161488",
    "price": 4180,
    "title": "MySQL培底入門 第4版 MySQL 8.0察応"
  },
  {
    "isbn": "978-4798151120",
    "price": 3278,
    "title": "独習Java 新版"
  },
  {
    "isbn": "978-4295008477",
    "price": 2860,
    "title": "新䞖代Javaプログラミングガむド[Java SE 10/11/12/13ず蚀語拡匵プロゞェクト]"
  }
]

ログはこんな感じになりたす。

2020-09-26 03:48:16,822 ERROR [org.jbo.res.res.i18n] (vert.x-eventloop-thread-14) RESTEASY002020: Unhandled asynchronous exception, sending back 500: java.lang.RuntimeException: oops!
    at org.littlewings.quarkus.reactive.mysql.BookResource.lambda$manualTransactionRegister$8(BookResource.java:107)
    at io.smallrye.mutiny.operators.UniOnItemTransformToMulti$FlatMapPublisherSubscriber.onItem(UniOnItemTransformToMulti.java:117)
    at io.smallrye.mutiny.context.ContextPropagationUniInterceptor$1.lambda$onItem$1(ContextPropagationUniInterceptor.java:35)
    at io.smallrye.context.SmallRyeThreadContext.lambda$withContext$0(SmallRyeThreadContext.java:217)
    at io.smallrye.mutiny.context.ContextPropagationUniInterceptor$1.onItem(ContextPropagationUniInterceptor.java:35)
    at io.smallrye.mutiny.operators.UniSerializedSubscriber.onItem(UniSerializedSubscriber.java:72)
    at io.smallrye.mutiny.vertx.AsyncResultUni.lambda$subscribing$1(AsyncResultUni.java:34)
    at io.vertx.mutiny.sqlclient.PreparedQuery$3.handle(PreparedQuery.java:161)
    at io.vertx.mutiny.sqlclient.PreparedQuery$3.handle(PreparedQuery.java:158)
    at io.vertx.sqlclient.impl.SqlResultHandler.complete(SqlResultHandler.java:97)
    at io.vertx.sqlclient.impl.SqlResultHandler.handle(SqlResultHandler.java:86)
    at io.vertx.sqlclient.impl.SqlResultHandler.handle(SqlResultHandler.java:33)
    at io.vertx.sqlclient.impl.TransactionImpl.lambda$wrap$2(TransactionImpl.java:139)

最埌にtruncate。

$ curl -i -XDELETE localhost:8080/book
HTTP/1.1 200 OK
Content-Length: 16
Content-Type: application/json

{"message":"OK"}

0件になりたした。

$ curl -s localhost:8080/book | jq
[]

たずめ

QuarkusのReactive MySQL Clientを詊しおみたした。

リアクティブなSQLクラむアントを䜿うのは初めおだったので、だいぶおこずりたしたが、なんずかなりたした 。

緎習を繰り返さないず䜿いこなせない気がずおもずおもするのですが、Munity含め、少しず぀頑匵っおみたしょう。

最埌に、䜜成したJAX-RSリ゜ヌスクラス党䜓を茉せおおきたす。
src/main/java/org/littlewings/quarkus/reactive/mysql/BookResource.java

package org.littlewings.quarkus.reactive.mysql;

import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
import javax.inject.Inject;
import javax.ws.rs.Consumes;
import javax.ws.rs.DELETE;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.PUT;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;

import io.smallrye.mutiny.Multi;
import io.smallrye.mutiny.Uni;
import io.vertx.mutiny.mysqlclient.MySQLPool;
import io.vertx.mutiny.sqlclient.Row;
import io.vertx.mutiny.sqlclient.RowIterator;
import io.vertx.mutiny.sqlclient.SqlClientHelper;
import io.vertx.mutiny.sqlclient.Tuple;

@Path("book")
public class BookResource {
    @Inject
    MySQLPool client;

    @GET
    @Produces(MediaType.APPLICATION_JSON)
    public Multi<Book> findAll() {
        return client
                .preparedQuery("select isbn, title, price from book order by price desc")
                .execute()
                .onItem()
                .transformToMulti(Multi.createFrom()::iterable)
                .onItem()
                .transform(row -> Book.create(row.getString("isbn"), row.getString("title"), row.getInteger("price")));
    }

    @GET
    @Path("{isbn}")
    @Produces(MediaType.APPLICATION_JSON)
    public Uni<Book> find(@PathParam("isbn") String isbn) {
        return client
                .preparedQuery("select isbn, title, price from book where isbn = ?")
                .execute(Tuple.of(isbn))
                .onItem()
                .transform(rows -> {
                    RowIterator<Row> iterator = rows.iterator();
                    Row row = iterator.next();

                    return Book.create(row.getString("isbn"), row.getString("title"), row.getInteger("price"));
                });
    }

    @PUT
    @Path("{isbn}")
    @Consumes(MediaType.APPLICATION_JSON)
    @Produces(MediaType.APPLICATION_JSON)
    public Uni<Book> put(Book book) {
        return SqlClientHelper
                .inTransactionUni(client, tx ->
                        tx
                                .preparedQuery("insert into book(isbn, title, price) values(?, ?, ?)")
                                .execute(Tuple.of(book.getIsbn(), book.getTitle(), book.getPrice()))
                                .onItem()
                                .transform(rows -> book)
                );
    }

    @POST
    @Consumes(MediaType.APPLICATION_JSON)
    @Produces(MediaType.APPLICATION_JSON)
    public Multi<Book> register(List<Book> books) {
        return SqlClientHelper
                .inTransactionMulti(client, tx -> {
                    List<Tuple> tuples =
                            books.stream().map(b -> Tuple.of(b.getIsbn(), b.getTitle(), b.getPrice())).collect(Collectors.toList());

                    return tx
                            .preparedQuery("insert into book(isbn, title, price) values(?, ?, ?)")
                            .executeBatch(tuples)
                            .onItem()
                            .transformToMulti(rows -> Multi.createFrom().items(books.stream()));
                });
    }

    @POST
    @Path("manual")
    @Consumes(MediaType.APPLICATION_JSON)
    @Produces(MediaType.APPLICATION_JSON)
    public Multi<Book> manualTransactionRegister(List<Book> books) {
        List<Tuple> tuples =
                books.stream().map(b -> Tuple.of(b.getIsbn(), b.getTitle(), b.getPrice())).collect(Collectors.toList());

        return client
                .begin()
                .onItem()
                .transformToMulti(tx ->
                        tx
                                .preparedQuery("insert into book(isbn, title, price) values(?, ?, ?)")
                                .executeBatch(tuples)
                                .onItem()
                                .<Book>transformToMulti(v -> {
                                    throw new RuntimeException("oops!");  // -> rollback
                                })
                                // .transformToMulti(v1 -> tx.commit().onItem().transformToMulti(v2 -> Multi.createFrom().items(books.stream())))  // -> commit
                                .onFailure()
                                .recoverWithMulti(th ->
                                    tx.rollback().onItem().transformToMulti(v -> Multi.createFrom().failure(th))
                                )
                );
    }

    @DELETE
    @Produces(MediaType.APPLICATION_JSON)
    public Uni<Map<String, String>> truncate() {
        return client
                .preparedQuery("truncate table book")
                .execute()
                .onItem()
                .transform(rows -> Map.of("message", "OK"));
    }
}

Terraformのprovidersコマンドを詊す

Terraform

これは、なにをしたくお曞いたもの

Terraformのprovidersずいうコマンドにちょっず興味があったので、調べおみようかず。

terraform providersコマンド

providersず蚀っおいるのは、terraformに含たれるコマンドです。

Command: providers - Terraform by HashiCorp

providersコマンドを䜿うず、珟圚の構成ファむルで䜿甚しおいるTerraform Providerの情報を、䟝存関係を解析したうえで
衚瀺しおくれたす。

さらにサブコマンドもあり、mirrorずschemaがありたす。

Command: providers mirror - Terraform by HashiCorp

Command: providers schema - Terraform by HashiCorp

mirrorは、珟圚の構成に必芁なProviderをダりンロヌドし、オフラむンでも䜿えるようにする機胜です。Terraformを利甚する際に、
Providerを倖郚からダりンロヌドできない堎合などに䜿甚するようです。

こちらは、今回はパス。

schemaは、Providerが持っおいるリ゜ヌスやデヌタ゜ヌスに関するスキヌマ情報を出力しおくれたす。こちらは、今回詊しお
みようず思いたす。

環境

今回の環境は、こちら。

$ terraform version
Terraform v0.13.3

この状態で、詊しおいきたす。

providersコマンドを詊す

たずは、providersコマンドを詊しおみたす。

Command: providers - Terraform by HashiCorp

こんな構成ファむルを甚意。今回はConsul Providerを䜿甚したした。
main.tf

terraform {
  required_version = "0.13.3"

  required_providers {
    consul = {
      source  = "hashicorp/consul"
      version = "2.10.0"
    }
  }
}

provider "consul" {
}

terraform initしお

$ terraform init

確認するず、こんな感じに衚瀺されたす。

$ terraform providers

Providers required by configuration:
.
└── provider[registry.terraform.io/hashicorp/consul] 2.10.0

゜ヌスコヌドを芋るず、構成Configurationの他に、Stateに関するProviderも衚瀺しおくれるようです。

https://github.com/hashicorp/terraform/blob/v0.13.3/command/providers.go#L117-L125

もう少しバリ゚ヌションを詊しおみたす。

2぀Providerを䜿っおいる堎合。Consul ProviderずMySQL Providerを䜿甚。
main.tf

terraform {
  required_version = "0.13.3"

  required_providers {
    consul = {
      source  = "hashicorp/consul"
      version = "2.10.0"
    }

    mysql = {
      source  = "terraform-providers/mysql"
      version = "1.9.0"
    }
  }
}

provider "consul" {
}

provider "mysql" {
}

terraform init埌に実行するず、こんな感じになりたす。

$ terraform providers

Providers required by configuration:
.
├── provider[registry.terraform.io/hashicorp/consul] 2.10.0
└── provider[registry.terraform.io/terraform-providers/mysql] 1.9.0

この衚瀺内容は、versionの曞き方に䟝存するようなので、たずえばこんな感じに倉曎するず

  required_providers {
    consul = {
      source  = "hashicorp/consul"
      version = ">= 2.10"
    }

    mysql = {
      source  = "terraform-providers/mysql"
      version = ">= 1.9"
    }
  }

terraform providersの結果にも反映されたす。

$ terraform providers

Providers required by configuration:
.
├── provider[registry.terraform.io/hashicorp/consul] >= 2.10.*
└── provider[registry.terraform.io/terraform-providers/mysql] >= 1.9.*

最埌に、backendも付けおみたす。backendにはConsulを䜿甚したした。
main.tf

terraform {
  required_version = "0.13.3"

  required_providers {
    consul = {
      source  = "hashicorp/consul"
      version = "2.10.0"
    }

    mysql = {
      source  = "terraform-providers/mysql"
      version = "1.9.0"
    }
  }

  backend "consul" {
    address = "172.17.0.2:8500"
    scheme  = "http"
    path    = "state"
    lock    = true
  }
}

provider "consul" {
}

provider "mysql" {
  endpoint = "172.17.0.3:3306"
  username = "root"
  password = "password"
}

resource "mysql_database" "app" {
  name = "my_database"
}

ちょっず、リ゜ヌス定矩自䜓が増えおいたすが 。

たずはinitしたす。

$ terraform init

この時点では、Stateが䜿甚しおいるProviderは実は珟れたせん。

$ terraform providers

Providers required by configuration:
.
├── provider[registry.terraform.io/terraform-providers/mysql] 1.9.0
└── provider[registry.terraform.io/hashicorp/consul] 2.10.0

では、applyしおみたす。

$ terraform apply

するず、State偎のProviderも出珟したす。

$ terraform providers

Providers required by configuration:
.
├── provider[registry.terraform.io/terraform-providers/mysql] 1.9.0
└── provider[registry.terraform.io/hashicorp/consul] 2.10.0

Providers required by state:

    provider[registry.terraform.io/terraform-providers/mysql]

ですが、出珟したのはMySQL Providerですね。

これっお、もしかしお「Stateに情報を保存しおいるProvider」の情報を衚瀺しおいるんでしょうか

そこで、構成ファむルを倉曎しお、Consulに関するリ゜ヌスも远加しおみたす。
main.tf

terraform {
  required_version = "0.13.3"

  required_providers {
    consul = {
      source  = "hashicorp/consul"
      version = "2.10.0"
    }

    mysql = {
      source  = "terraform-providers/mysql"
      version = "1.9.0"
    }
  }

  backend "consul" {
    address = "172.17.0.2:8500"
    scheme  = "http"
    path    = "state"
    lock    = true
  }
}

provider "consul" {
  address = "172.17.0.2:8500"
  scheme  = "http"
}

provider "mysql" {
  endpoint = "172.17.0.3:3306"
  username = "root"
  password = "password"
}

resource "consul_config_entry" "web" {
  name = "web"
  kind = "service-defaults"

  config_json = jsonencode({
    Protocol = "http"
  })
}

resource "mysql_database" "app" {
  name = "my_database"
}

terraform apply埌に確認するず、このようになりたす。

$ terraform providers

Providers required by configuration:
.
├── provider[registry.terraform.io/terraform-providers/mysql] 1.9.0
└── provider[registry.terraform.io/hashicorp/consul] 2.10.0

Providers required by state:

    provider[registry.terraform.io/hashicorp/consul]

    provider[registry.terraform.io/terraform-providers/mysql]

やっぱり、Stateに情報を保存しおいるProviderが衚瀺されおいるようですね。

そもそも、State自䜓の゜ヌスコヌドはTerraform本䜓に含たれおいるようなので、backendに遞んだものが珟れるわけではない、ず。 。

https://github.com/hashicorp/terraform/tree/v0.13.3/backend/remote-state

このあたり、そのうちもう少しだけ远いたいずころ。

providers schemaコマンド

次は、schemaコマンド。schemaコマンドを䜿甚するこずで、構成ファむルで䜿甚しおいるProviderのスキヌマ情報を
衚瀺しおくれたす。

Command: providers schema - Terraform by HashiCorp

たずえば、Consul Providerを䜿甚するこんな構成ファむルがあったずしお main.tf

terraform {
  required_version = "0.13.3"

  required_providers {
    consul = {
      source  = "hashicorp/consul"
      version = "2.10.0"
    }
  }
}

provider "consul" {
}

initしたす。

$ terraform init

その埌、providers schemaコマンドを実行したす。-jsonオプションが必芁です。

$ terraform providers schema -json | jq

結果は、jqで敎圢しおいたす。

{
  "format_version": "0.1",
  "provider_schemas": {
    "registry.terraform.io/hashicorp/consul": {
      "provider": {
        "version": 0,
        "block": {
          "attributes": {
            "address": {
              "type": "string",
              "description_kind": "plain",
              "optional": true
            },
            "ca_file": {
              "type": "string",
              "description_kind": "plain",
              "optional": true
            },
            "ca_path": {
              "type": "string",
              "description_kind": "plain",
              "optional": true
            },
            "ca_pem": {
              "type": "string",
              "description_kind": "plain",
              "optional": true
            },

〜省略〜

            "token": {
              "type": "string",
              "description_kind": "plain",
              "optional": true,
              "sensitive": true
            }
          },
          "description_kind": "plain"
        }
      },
      "resource_schemas": {
        "consul_acl_auth_method": {
          "version": 0,
          "block": {
            "attributes": {
              "config": {
                "type": [
                  "map",
                  "string"
                ],
                "description": "The raw configuration for this ACL auth method.",
                "description_kind": "plain",
                "optional": true
              },
              "config_json": {
                "type": "string",
                "description": "The raw configuration for this ACL auth method.",
                "description_kind": "plain",
                "optional": true
              },
              "description": {
                "type": "string",
                "description": "A free form human readable description of the auth method.",
                "description_kind": "plain",
                "optional": true
              },
              "display_name": {
                "type": "string",
                "description": "An optional name to use instead of the name attribute when displaying information about this auth method.",
                "description_kind": "plain",
                "optional": true
              },
              "id": {
                "type": "string",
                "description_kind": "plain",
                "optional": true,
                "computed": true
              },

〜省略〜

      },
      "data_source_schemas": {
        "consul_acl_auth_method": {
          "version": 0,
          "block": {
            "attributes": {
              "config": {
                "type": [
                  "map",
                  "string"
                ],
                "description_kind": "plain",
                "computed": true
              },
              "config_json": {
                "type": "string",
                "description": "The raw configuration for this ACL auth method.",
                "description_kind": "plain",
                "computed": true
              },
              "description": {
                "type": "string",
                "description_kind": "plain",
                "computed": true
              },
              "display_name": {
                "type": "string",
                "description_kind": "plain",
                "computed": true
              },

〜省略〜

            },
            "description_kind": "plain"
          }
        }
      }
    }
  }
}

Provider自䜓のスキヌマ情報、リ゜ヌス、そしおデヌタ゜ヌスのスキヌマ情報を衚瀺しおくれたす。

ブロックで定矩する属性の情報は、こんな感じ。

            "block_types": {
              "namespace_rule": {
                "nesting_mode": "list",
                "block": {
                  "attributes": {
                    "bind_namespace": {
                      "type": "string",
                      "description_kind": "plain",
                      "required": true
                    },
                    "selector": {
                      "type": "string",
                      "description_kind": "plain",
                      "optional": true
                    }
                  },
                  "description_kind": "plain"
                }
              }
            },

ドキュメントにも蚘茉がありたす。

Block Representation

たた、ドキュメントではわからない、各属性のtypeなどがわかっお䟿利なのですが、さすがにデフォルト倀や
map等の属性に関しおはわからないですね 。

              "config": {
                "type": [
                  "map",
                  "string"
                ],
                "description_kind": "plain",
                "required": true
              },

このあたりは、ドキュメントを頌るしかないでしょう。

このproviders schemaコマンドは、䜿甚しおいるリ゜ヌス等のスキヌマ定矩ではなく、䟝存しおいるProviderのスキヌマ定矩を
衚瀺するので、䜿っおいないリ゜ヌス等のスキヌマも衚瀺しおくれたす。

ゆえに、倧量に衚瀺されるのですが 。

必芁なものに絞っお出力しおもよいでしょう。

たずえば、consul_serviceリ゜ヌスだけをjqコマンドで抜粋しおみたす。

consul_service

$ terraform providers schema -json | jq '.provider_schemas."registry.terraform.io/hashicorp/consul".resource_schemas.consul_service'
{
  "version": 0,
  "block": {
    "attributes": {
      "address": {
        "type": "string",
        "description_kind": "plain",
        "optional": true,
        "computed": true
      },
      "datacenter": {
        "type": "string",
        "description_kind": "plain",
        "optional": true,
        "computed": true
      },
      "enable_tag_override": {
        "type": "bool",
        "description_kind": "plain",
        "optional": true
      },
      "external": {
        "type": "bool",
        "description_kind": "plain",
        "optional": true
      },
      "id": {
        "type": "string",
        "description_kind": "plain",
        "optional": true,
        "computed": true
      },
      "meta": {
        "type": [
          "map",
          "string"
        ],
        "description_kind": "plain",
        "optional": true
      },
      "name": {
        "type": "string",
        "description_kind": "plain",
        "required": true
      },
      "namespace": {
        "type": "string",
        "description_kind": "plain",
        "optional": true
      },
      "node": {
        "type": "string",
        "description_kind": "plain",
        "required": true
      },
      "port": {
        "type": "number",
        "description_kind": "plain",
        "optional": true
      },
      "service_id": {
        "type": "string",
        "description_kind": "plain",
        "optional": true,
        "computed": true
      },
      "tags": {
        "type": [
          "list",
          "string"
        ],
        "description_kind": "plain",
        "optional": true
      }
    },
    "block_types": {
      "check": {
        "nesting_mode": "set",
        "block": {
          "attributes": {
            "check_id": {
              "type": "string",
              "description_kind": "plain",
              "required": true
            },
            "deregister_critical_service_after": {
              "type": "string",
              "description_kind": "plain",
              "optional": true
            },
            "http": {
              "type": "string",
              "description_kind": "plain",
              "optional": true
            },
            "interval": {
              "type": "string",
              "description_kind": "plain",
              "required": true
            },
            "method": {
              "type": "string",
              "description_kind": "plain",
              "optional": true
            },
            "name": {
              "type": "string",
              "description_kind": "plain",
              "required": true
            },
            "notes": {
              "type": "string",
              "description_kind": "plain",
              "optional": true
            },
            "status": {
              "type": "string",
              "description_kind": "plain",
              "optional": true,
              "computed": true
            },
            "tcp": {
              "type": "string",
              "description_kind": "plain",
              "optional": true
            },
            "timeout": {
              "type": "string",
              "description_kind": "plain",
              "required": true
            },
            "tls_skip_verify": {
              "type": "bool",
              "description_kind": "plain",
              "optional": true
            }
          },
          "block_types": {
            "header": {
              "nesting_mode": "set",
              "block": {
                "attributes": {
                  "name": {
                    "type": "string",
                    "description_kind": "plain",
                    "required": true
                  },
                  "value": {
                    "type": [
                      "list",
                      "string"
                    ],
                    "description_kind": "plain",
                    "required": true
                  }
                },
                "description_kind": "plain"
              }
            }
          },
          "description_kind": "plain"
        }
      }
    },
    "description_kind": "plain"
  }
}

スキヌマに関する情報は、このあたりを参考に。

https://github.com/hashicorp/terraform/blob/v0.13.3/command/providers_schema.go

https://github.com/hashicorp/terraform/blob/v0.13.3/terraform/schemas.go

https://github.com/hashicorp/terraform/blob/v0.13.3/configs/configschema/schema.go