lidavidm commented on code in PR #697: URL: https://github.com/apache/arrow-adbc/pull/697#discussion_r1221448184
########## csharp/src/Apache.Arrow.Adbc/Core/AdbcStatement.cs: ########## @@ -0,0 +1,287 @@ +/* + * 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. + */ + +using System; +using System.Linq; +using System.Text.RegularExpressions; +using System.Threading.Tasks; +using Apache.Arrow.C; +using Apache.Arrow.Ipc; +using Apache.Arrow.Types; + +namespace Apache.Arrow.Adbc.Core +{ + /// <summary> + /// Statements may represent queries or prepared statements. Statements may be used multiple times and can be reconfigured (e.g. they can be reused to execute multiple different queries). + /// </summary> + public abstract class AdbcStatement : IDisposable + { + public AdbcStatement() + { + Timeout = 30; + } + + /// <summary> + /// Gets or sets a SQL query to be executed on this statement. + /// </summary> + public virtual string SqlQuery { get; set; } + + /// <summary> + /// Gets or sets the Substrait plan. + /// </summary> + public virtual byte[] SubstraitPlan + { + get { throw new NotImplementedException(); } + set { throw new NotImplementedException(); } + } + + public virtual void Bind(RecordBatch batch,Schema schema) + { + throw AdbcException.NotImplemented("Statement does not support Bind"); + } + + /// <summary> + /// Executes the statement and returns a tuple containing the number of records and the <see cref="IArrowArrayStream"/>.. + /// </summary> + /// <returns>A <see cref="ValueTuple"/> where the first item is the number of records and the second is the <see cref="IArrowArrayStream"/>.</returns> + public abstract QueryResult ExecuteQuery(); + + /// <summary> + /// Executes the statement and returns a tuple containing the number of records and the <see cref="IArrowArrayStream"/>.. + /// </summary> + /// <returns>A <see cref="ValueTuple"/> where the first item is the number of records and the second is the <see cref="IArrowArrayStream"/>.</returns> + public virtual async ValueTask<QueryResult> ExecuteQueryAsync() + { + return await Task.Run(() => ExecuteQuery()); + } + + /// <summary> + /// Executes an update command and returns the number of records effected. + /// </summary> + /// <returns></returns> + /// <exception cref="NotImplementedException"></exception> + public abstract UpdateResult ExecuteUpdate(); + + // <summary> + /// Executes an update command and returns the number of records effected. + /// </summary> + /// <returns></returns> + /// <exception cref="NotImplementedException"></exception> + public virtual async Task<UpdateResult> ExecuteUpdateAsync() + { + return await Task.Run(() => ExecuteUpdate()); + } + + /// <summary> + /// Timeout (in seconds) for statement execution. + /// </summary> + /// <remarks>The default is 30 seconds.</remarks> + public virtual int Timeout { get; set; } Review Comment: Correct, there's not a 'standard' timeout parameter (perhaps we should define one?) but individual drivers often have this -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
