isapego commented on code in PR #1212: URL: https://github.com/apache/ignite-3/pull/1212#discussion_r996485302
########## modules/platforms/dotnet/Apache.Ignite/Table/IKeyValueView.cs: ########## @@ -0,0 +1,203 @@ +/* + * 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. + */ + +namespace Apache.Ignite.Table; + +using System.Collections.Generic; +using System.Threading.Tasks; +using Transactions; + +/// <summary> +/// Key-value view provides access to table records in form of separate key and value parts. +/// </summary> +/// <typeparam name="TK">Key type.</typeparam> +/// <typeparam name="TV">Value type.</typeparam> +public interface IKeyValueView<TK, TV> + where TK : notnull + where TV : notnull +{ + /// <summary> + /// Gets a value associated with the given key. + /// </summary> + /// <param name="transaction">The transaction or <c>null</c> to auto commit.</param> + /// <param name="key">Key.</param> + /// <returns> + /// A <see cref="Task{TResult}"/> representing the asynchronous operation. + /// The task result contains the value for the specified key, or an <see cref="Option{T}"/> instance without a value + /// when specified key is not present in the table. + /// </returns> + Task<Option<TV>> GetAsync(ITransaction? transaction, TK key); + + /// <summary> + /// Gets multiple records by keys. + /// </summary> + /// <param name="transaction">The transaction or <c>null</c> to auto commit.</param> + /// <param name="keys">Keys.</param> + /// <returns> + /// A <see cref="Task"/> representing the asynchronous operation. + /// The task result contains a dictionary with specified keys and their values. If a record for a particular key does not exist, + /// it will not be present in the resulting dictionary. + /// </returns> + Task<IDictionary<TK, TV>> GetAllAsync(ITransaction? transaction, IEnumerable<TK> keys); + + /// <summary> + /// Determines if the table contains an entry for the specified key. + /// </summary> + /// <param name="transaction">The transaction or <c>null</c> to auto commit.</param> + /// <param name="key">Keys.</param> + /// <returns> + /// A <see cref="Task"/> representing the asynchronous operation. + /// The task result is <c>true</c> if a value exists for the specified key, and <c>false</c> otherwise. + /// </returns> + Task<bool> ContainsAsync(ITransaction? transaction, TK key); + + /// <summary> + /// Puts a value with a given key. + /// </summary> + /// <param name="transaction">The transaction or <c>null</c> to auto commit.</param> + /// <param name="key">Key.</param> + /// <param name="val">Value.</param> + /// <returns>A <see cref="Task{TResult}"/> representing the asynchronous operation.</returns> + Task PutAsync(ITransaction? transaction, TK key, TV val); + + /// <summary> + /// Puts multiple key-value pairs. + /// </summary> + /// <param name="transaction">The transaction or <c>null</c> to auto commit.</param> + /// <param name="pairs">Pairs.</param> + /// <returns>A <see cref="Task{TResult}"/> representing the asynchronous operation.</returns> + Task PutAllAsync(ITransaction? transaction, IEnumerable<KeyValuePair<TK, TV>> pairs); + + /// <summary> + /// Gets a value associated with the given key. Review Comment: Not just gets I believe -- 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]
