Skip to content
This repository has been archived by the owner on May 10, 2022. It is now read-only.

Commit

Permalink
fix comment
Browse files Browse the repository at this point in the history
  • Loading branch information
foreverneverer committed Sep 4, 2020
1 parent 88b5e88 commit a098625
Showing 1 changed file with 3 additions and 19 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -44,25 +44,9 @@ public interface PegasusClientInterface {
/**
* Open a table, and prepare the sessions and route-table to the replica-servers.
*
* <p>Note: this interface is deprecated, retaining it only for compatibility, please see {@link
* PegasusClientInterface#openTable(String, TableOptions)}
*
* <p>Please notice that pegasus support two kinds of API: 1. the client-interface way, which is
* provided in this class. 2. the table-interface way, which is provided by {@link
* PegasusTableInterface}. With the client-interface, you don't need to create
* PegasusTableInterface by openTable, so you can access the pegasus cluster conveniently.
* However, the client-interface's api also has some restrictions: 1. we don't provide async
* methods in client-interface. 2. the timeout in client-interface isn't as accurate as the
* table-interface. 3. the client-interface may throw an exception when open table fails. It means
* that you may need to handle this exception in every data access operation, which is annoying.
* 4. You can't specify a per-operation timeout. So we recommend you to use the table-interface.
*
* @param tableName the table should be exist on the server, which is created before by the system
* administrator
* @param backupRequestDelayMs the delay time to send backup request. If backupRequestDelayMs <=
* 0, The backup request is disabled.
* @return the table handler
* @throws PException throws exception if any error occurs.
* @deprecated retaining it only for compatibility, we will remove it later, don't use it any
* more. the latest interface please see {@link PegasusClientInterface#openTable(String,
* TableOptions)}
*/
@Deprecated
public PegasusTableInterface openTable(String tableName, int backupRequestDelayMs)
Expand Down

0 comments on commit a098625

Please sign in to comment.