[GitHub] [ignite-3] tledkov-gridgain commented on a change in pull request #326: IGNITE-15212 Add SQL API

[GitBox <gi...@apache.org>]

tledkov-gridgain commented on a change in pull request #326:
URL: https://github.com/apache/ignite-3/pull/326#discussion_r799317281



##########
File path: modules/api/src/main/java/org/apache/ignite/sql/Session.java
##########
@@ -0,0 +1,144 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.ignite.sql;
+
+import java.util.List;
+import java.util.concurrent.TimeUnit;
+import org.apache.ignite.sql.async.AsyncSession;
+import org.apache.ignite.sql.reactive.ReactiveSession;
+import org.apache.ignite.tx.Transaction;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+/**
+ * SQL Session provides methods for query execution.
+ *
+ * <p>Session is a stateful object and holds setting that intended to be used as defaults for the new queries. Session "execute*" methods
+ * are thread-safe and can be called from different threads. Calling other methods, which modify the session state, from concurrent threads
+ * may lead to unexpected behaviour.
+ */
+public interface Session extends AsyncSession, ReactiveSession {
+    /** Default schema name. */
+    String DEFAULT_SCHEMA = "PUBLIC";
+
+    /**
+     * Sets default query timeout.
+     *
+     * @param timeout Query timeout value.
+     * @param timeUnit Timeunit.
+     */
+    void defaultTimeout(long timeout, @NotNull TimeUnit timeUnit);
+
+    /**
+     * Return default query timeout.
+     *
+     * @param timeUnit Timeunit to convert timeout to.
+     * @return Default query timeout in the given timeunit.
+     */
+    long defaultTimeout(@NotNull TimeUnit timeUnit);
+
+    /**
+     * Sets default schema for the session, which the queries will be executed with.
+     *
+     * <p>Default schema is used to resolve table names, for which schema was not specified in the query text, to their canonical names.
+     *
+     * @param schema Default schema.
+     */
+    void defaultSchema(@NotNull String schema);
+
+    /**
+     * Returns session default schema.
+     *
+     * <p>Default value is {@link #DEFAULT_SCHEMA}.
+     *
+     * @return Session default schema.
+     * @see #defaultSchema(String)
+     */
+    @NotNull String defaultSchema();
+
+    /**
+     * Executes single SQL query.
+     *
+     * @param transaction Transaction to execute the query within or {@code null}.
+     * @param query SQL query template.
+     * @param arguments Arguments for the template (optional).
+     * @return SQL query results set.
+     * @throws SqlException If failed.
+     */
+    @NotNull ResultSet execute(@Nullable Transaction transaction, @NotNull String query, @Nullable Object... arguments);
+
+    /**
+     * Executes single SQL statement.
+     *
+     * @param transaction Transaction to execute the statement within or {@code null}.
+     * @param statement SQL statement to execute.
+     * @param arguments Arguments for the statement.
+     * @return SQL query results set.
+     */
+    @NotNull ResultSet execute(@Nullable Transaction transaction, @NotNull Statement statement, @Nullable Object... arguments);
+
+    /**
+     * Executes batched SQL query.

Review comment:
       Should we emphasize that only a DML (INSERT/UPDATE) statement is expected here?




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@ignite.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org