Client: documentation

Author: AnastasMIPT

src/Client/Connection.hpp

@@ -174,12 +174,32 @@ class Connection {
 	template <class T>
 	rid_t call(const std::string &func, const T &args);
 	rid_t ping();
+
+
+	/**
+	 * Execute the SQL statement contained in the 'statement' parameter.
+	 * @param statement statement, which should conform to the rules for SQL grammar
+	 * @param parameters tuple for placeholders in the statement
+	 * @retval request id
+	 */
 	template <class T>
 	rid_t execute(const std::string& statement, const T& parameters);
 
+		/**
+	 * Execute the SQL statement contained in the 'statement' parameter.
+	 * @param stmt_id the statement id obtained with prepare()
+	 * @param parameters tuple for placeholders in the statement
+	 * @retval request id
+	 */
 	template <class T>
 	rid_t execute(unsigned int stmt_id, const T& parameters);
 
+	/**
+	 * Prepare the SQL statement contained in the 'statement' parameter. 
+	 * The syntax and requirements for Connection::prepare() are the same as for Connection::execute().
+	 * @param statement statement, which should conform to the rules for SQL grammar
+	 * @retval request id
+	 */
 	rid_t prepare(const std::string& statement);
 
 	void setError(const std::string &msg);
@@ -424,7 +444,6 @@ Connection<BUFFER, NetProvider>::execute(const std::string& statement, const T&
 }
 
 template<class BUFFER, class NetProvider>
-<<<<<<< HEAD
 template <class T>
 rid_t
 Connection<BUFFER, NetProvider>::execute(unsigned int stmt_id, const T& parameters)
@@ -435,8 +454,6 @@ Connection<BUFFER, NetProvider>::execute(unsigned int stmt_id, const T& paramete
 }
 
 template<class BUFFER, class NetProvider>
-=======
->>>>>>> fc37e11... Client: prepare()
 rid_t
 Connection<BUFFER, NetProvider>::prepare(const std::string& statement)
 {

src/Client/RequestEncoder.hpp

@@ -84,7 +84,6 @@ class RequestEncoder {
 			    IteratorType iterator = EQ);
 	template <class T>
 	size_t encodeExecute(const std::string& statement, const T& parameters);
-	size_t encodePrepare(const std::string& statement);
 	template <class T>
 	size_t encodeExecute(unsigned int stmt_id, const T& parameters);
 	size_t encodePrepare(const std::string& statement);

src/Client/ResponseReader.hpp

@@ -426,7 +426,7 @@ struct ColumnMapKeyReader : mpp::SimpleReaderBase<BUFFER, mpp::MP_UINT> {
 				break;
 			}
 			default:
-				LOG_ERROR("Invalid error key: ", key);
+				LOG_ERROR("Invalid column map key: ", key);
 				dec.AbortAndSkipRead();
 		}
 	}