Add MySQLVal[] versions to all functions. Deprecate Variant[] versions.

Switch queryValue return type to MySQLVal instead of Variant.

Author: schveiguy

source/mysql/commands.d

@@ -24,6 +24,7 @@ import mysql.protocol.constants;
 import mysql.protocol.extra_types;
 import mysql.protocol.packets;
 import mysql.result;
+import mysql.types;
 
 /// This feature is not yet implemented. It currently has no effect.
 /+
@@ -205,12 +206,20 @@ ulong exec(T...)(Connection conn, const(char[]) sql, T args)
 	return exec(conn, prepared);
 }
 ///ditto
+deprecated("Variant support is deprecated. Use MySQLVal[] instead of Variant[]")
 ulong exec(Connection conn, const(char[]) sql, Variant[] args)
 {
 	auto prepared = conn.prepare(sql);
 	prepared.setArgs(args);
 	return exec(conn, prepared);
 }
+///ditto
+ulong exec(Connection conn, const(char[]) sql, MySQLVal[] args)
+{
+	auto prepared = conn.prepare(sql);
+	prepared.setArgs(args);
+	return exec(conn, prepared);
+}
 
 ///ditto
 ulong exec(Connection conn, ref Prepared prepared)
@@ -228,12 +237,20 @@ ulong exec(T...)(Connection conn, ref Prepared prepared, T args)
 	return exec(conn, prepared);
 }
 ///ditto
+deprecated("Variant support is deprecated. Use MySQLVal[] instead of Variant[]")
 ulong exec(Connection conn, ref Prepared prepared, Variant[] args)
 {
 	prepared.setArgs(args);
 	return exec(conn, prepared);
 }
 
+///ditto
+ulong exec(Connection conn, ref Prepared prepared, MySQLVal[] args)
+{
+	prepared.setArgs(args);
+	return exec(conn, prepared);
+}
+
 ///ditto
 ulong exec(Connection conn, ref BackwardCompatPrepared prepared)
 {
@@ -331,13 +348,22 @@ ResultRange query(T...)(Connection conn, const(char[]) sql, T args)
 	return query(conn, prepared);
 }
 ///ditto
+deprecated("Variant support is deprecated. Use MySQLVal[] instead of Variant[]")
 ResultRange query(Connection conn, const(char[]) sql, Variant[] args)
 {
 	auto prepared = conn.prepare(sql);
 	prepared.setArgs(args);
 	return query(conn, prepared);
 }
 
+///ditto
+ResultRange query(Connection conn, const(char[]) sql, MySQLVal[] args)
+{
+	auto prepared = conn.prepare(sql);
+	prepared.setArgs(args);
+	return query(conn, prepared);
+}
+
 ///ditto
 ResultRange query(Connection conn, ref Prepared prepared)
 {
@@ -354,11 +380,18 @@ ResultRange query(T...)(Connection conn, ref Prepared prepared, T args)
 	return query(conn, prepared);
 }
 ///ditto
+deprecated("Variant support is deprecated. Use MySQLVal[] instead of Variant[]")
 ResultRange query(Connection conn, ref Prepared prepared, Variant[] args)
 {
 	prepared.setArgs(args);
 	return query(conn, prepared);
 }
+///ditto
+ResultRange query(Connection conn, ref Prepared prepared, MySQLVal[] args)
+{
+	prepared.setArgs(args);
+	return query(conn, prepared);
+}
 
 ///ditto
 ResultRange query(Connection conn, ref BackwardCompatPrepared prepared)
@@ -461,6 +494,14 @@ Nullable!Row queryRow(T...)(Connection conn, const(char[]) sql, T args)
 	return queryRow(conn, prepared);
 }
 ///ditto
+Nullable!Row queryRow(Connection conn, const(char[]) sql, MySQLVal[] args)
+{
+	auto prepared = conn.prepare(sql);
+	prepared.setArgs(args);
+	return queryRow(conn, prepared);
+}
+///ditto
+deprecated("Variant support is deprecated. Use MySQLVal[] instead of Variant[]")
 Nullable!Row queryRow(Connection conn, const(char[]) sql, Variant[] args)
 {
 	auto prepared = conn.prepare(sql);
@@ -484,11 +525,18 @@ Nullable!Row queryRow(T...)(Connection conn, ref Prepared prepared, T args)
 	return queryRow(conn, prepared);
 }
 ///ditto
+deprecated("Variant support is deprecated. Use MySQLVal[] instead of Variant[]")
 Nullable!Row queryRow(Connection conn, ref Prepared prepared, Variant[] args)
 {
 	prepared.setArgs(args);
 	return queryRow(conn, prepared);
 }
+///ditto
+Nullable!Row queryRow(Connection conn, ref Prepared prepared, MySQLVal[] args)
+{
+	prepared.setArgs(args);
+	return queryRow(conn, prepared);
+}
 
 ///ditto
 Nullable!Row queryRow(Connection conn, ref BackwardCompatPrepared prepared)
@@ -672,50 +720,65 @@ delegate.
 csa = An optional array of `ColumnSpecialization` structs. If you need to
 use this with a prepared statement, please use `mysql.prepared.Prepared.columnSpecials`.
 +/
-Nullable!Variant queryValue(Connection conn, const(char[]) sql, ColumnSpecialization[] csa = null)
+Nullable!MySQLVal queryValue(Connection conn, const(char[]) sql, ColumnSpecialization[] csa = null)
 {
 	return queryValueImpl(csa, conn, ExecQueryImplInfo(false, sql));
 }
 ///ditto
-Nullable!Variant queryValue(T...)(Connection conn, const(char[]) sql, T args)
+Nullable!MySQLVal queryValue(T...)(Connection conn, const(char[]) sql, T args)
 	if(T.length > 0 && !is(T[0] == Variant[]) && !is(T[0] == ColumnSpecialization) && !is(T[0] == ColumnSpecialization[]))
 {
 	auto prepared = conn.prepare(sql);
 	prepared.setArgs(args);
 	return queryValue(conn, prepared);
 }
 ///ditto
-Nullable!Variant queryValue(Connection conn, const(char[]) sql, Variant[] args)
+Nullable!MySQLVal queryValue(Connection conn, const(char[]) sql, MySQLVal[] args)
+{
+	auto prepared = conn.prepare(sql);
+	prepared.setArgs(args);
+	return queryValue(conn, prepared);
+}
+///ditto
+deprecated("Variant support is deprecated. Use MySQLVal[] instead of Variant[]")
+Nullable!MySQLVal queryValue(Connection conn, const(char[]) sql, Variant[] args)
 {
 	auto prepared = conn.prepare(sql);
 	prepared.setArgs(args);
 	return queryValue(conn, prepared);
 }
 
 ///ditto
-Nullable!Variant queryValue(Connection conn, ref Prepared prepared)
+Nullable!MySQLVal queryValue(Connection conn, ref Prepared prepared)
 {
 	auto preparedInfo = conn.registerIfNeeded(prepared.sql);
 	auto result = queryValueImpl(prepared.columnSpecials, conn, prepared.getExecQueryImplInfo(preparedInfo.statementId));
 	prepared._lastInsertID = conn.lastInsertID; // Conceivably, this might be needed when multi-statements are enabled.
 	return result;
 }
 ///ditto
-Nullable!Variant queryValue(T...)(Connection conn, ref Prepared prepared, T args)
+Nullable!MySQLVal queryValue(T...)(Connection conn, ref Prepared prepared, T args)
 	if(T.length > 0 && !is(T[0] == Variant[]) && !is(T[0] == ColumnSpecialization) && !is(T[0] == ColumnSpecialization[]))
 {
 	prepared.setArgs(args);
 	return queryValue(conn, prepared);
 }
 ///ditto
-Nullable!Variant queryValue(Connection conn, ref Prepared prepared, Variant[] args)
+Nullable!MySQLVal queryValue(Connection conn, ref Prepared prepared, MySQLVal[] args)
+{
+	prepared.setArgs(args);
+	return queryValue(conn, prepared);
+}
+///ditto
+deprecated("Variant support is deprecated. Use MySQLVal[] instead of Variant[]")
+Nullable!MySQLVal queryValue(Connection conn, ref Prepared prepared, Variant[] args)
 {
 	prepared.setArgs(args);
 	return queryValue(conn, prepared);
 }
 
 ///ditto
-Nullable!Variant queryValue(Connection conn, ref BackwardCompatPrepared prepared)
+Nullable!MySQLVal queryValue(Connection conn, ref BackwardCompatPrepared prepared)
 {
 	auto p = prepared.prepared;
 	auto result = queryValue(conn, p);
@@ -724,21 +787,21 @@ Nullable!Variant queryValue(Connection conn, ref BackwardCompatPrepared prepared
 }
 
 /// Common implementation for `queryValue` overloads.
-package Nullable!Variant queryValueImpl(ColumnSpecialization[] csa, Connection conn,
+package Nullable!MySQLVal queryValueImpl(ColumnSpecialization[] csa, Connection conn,
 	ExecQueryImplInfo info)
 {
 	auto results = queryImpl(csa, conn, info);
 	if(results.empty)
-		return Nullable!Variant();
+		return Nullable!MySQLVal();
 	else
 	{
-		auto row = results.front;
+		auto row = results.safe.front;
 		results.close();
 
 		if(row.length == 0)
-			return Nullable!Variant();
+			return Nullable!MySQLVal();
 		else
-			return Nullable!Variant(row[0]);
+			return Nullable!MySQLVal(row[0]);
 	}
 }
 

source/mysql/connection.d

@@ -17,6 +17,7 @@ import mysql.protocol.constants;
 import mysql.protocol.packets;
 import mysql.protocol.sockets;
 import mysql.result;
+import mysql.types;
 debug(MYSQLN_TESTS)
 {
 	import mysql.test.common;
@@ -324,7 +325,7 @@ struct BackwardCompatPrepared
 
 	///ditto
 	deprecated("Change 'preparedStmt.queryValue()' to 'conn.queryValue(preparedStmt)'")
-	Nullable!Variant queryValue()
+	Nullable!MySQLVal queryValue()
 	{
 		return .queryValue(_conn, _prepared);
 	}

source/mysql/metadata.d

@@ -1,4 +1,4 @@
-/// Retrieve metadata from a DB.
+/// Retrieve metadata from a DB.
 module mysql.metadata;
 
 import std.array;
@@ -10,6 +10,7 @@ import mysql.commands;
 import mysql.exceptions;
 import mysql.protocol.sockets;
 import mysql.result;
+import mysql.types;
 
 /// A struct to hold column metadata
 struct ColumnInfo
@@ -24,24 +25,24 @@ struct ColumnInfo
 	size_t index;
 	/++
 	Is the COLUMN_DEFAULT column (in the information schema's COLUMNS table) NULL?
-	
+
 	What this means:
-	
+
 	On MariaDB 10.2.7 and up:
 	- Does the column have a default value?
-	
+
 	On MySQL and MariaDB 10.2.6 and below:
 	- This can be true if the column doesn't have a default value OR
 	if NULL is the column's default value.
-	
+
 	See_also:
 	See COLUMN_DEFAULT description at
 	$(LINK https://mariadb.com/kb/en/library/information-schema-columns-table/)
 	+/
 	bool defaultNull;
 	/++
 	The default value as a string if not NULL.
-	
+
 	Depending on the database (see comments for `defaultNull` and the
 	related "see also" link there), this may be either `null` or `"NULL"`
 	if the column's default value is NULL.
@@ -100,7 +101,7 @@ information that is available to the connected user. This may well be quite limi
 struct MetaData
 {
 	import mysql.connection;
-	
+
 private:
 	Connection _con;
 
@@ -110,13 +111,13 @@ private:
 		string query = procs ? "SHOW PROCEDURE STATUS WHERE db='": "SHOW FUNCTION STATUS WHERE db='";
 		query ~= _con.currentDB ~ "'";
 
-		auto rs = _con.query(query).array;
+		auto rs = _con.query(query).safe.array;
 		MySQLProcedure[] pa;
 		pa.length = rs.length;
 		foreach (size_t i; 0..rs.length)
 		{
 			MySQLProcedure foo;
-			Row r = rs[i];
+			auto r = rs[i];
 			foreach (int j; 0..11)
 			{
 				if (r.isNull(j))
@@ -174,16 +175,16 @@ public:
 
 	/++
 	List the available databases
-	
+
 	Note that if you have connected using the credentials of a user with
 	limited permissions you may not get many results.
-	
+
 	Returns:
 		An array of strings
 	+/
 	string[] databases()
 	{
-		auto rs = _con.query("SHOW DATABASES").array;
+		auto rs = _con.query("SHOW DATABASES").safe.array;
 		string[] dbNames;
 		dbNames.length = rs.length;
 		foreach (size_t i; 0..rs.length)
@@ -193,13 +194,13 @@ public:
 
 	/++
 	List the tables in the current database
-	
+
 	Returns:
 		An array of strings
 	+/
 	string[] tables()
 	{
-		auto rs = _con.query("SHOW TABLES").array;
+		auto rs = _con.query("SHOW TABLES").safe.array;
 		string[] tblNames;
 		tblNames.length = rs.length;
 		foreach (size_t i; 0..rs.length)
@@ -209,7 +210,7 @@ public:
 
 	/++
 	Get column metadata for a table in the current database
-	
+
 	Params:
 		table = The table name
 	Returns:
@@ -229,13 +230,13 @@ public:
 			" COLUMN_KEY, EXTRA, PRIVILEGES, COLUMN_COMMENT" ~
 			" FROM information_schema.COLUMNS WHERE" ~
 			" table_schema='" ~ _con.currentDB ~ "' AND table_name='" ~ table ~ "'";
-		auto rs = _con.query(query).array;
+		auto rs = _con.query(query).safe.array;
 		ColumnInfo[] ca;
 		ca.length = rs.length;
 		foreach (size_t i; 0..rs.length)
 		{
 			ColumnInfo col;
-			Row r = rs[i];
+			auto r = rs[i];
 			for (int j = 1; j < 19; j++)
 			{
 				string t;

source/mysql/result.d

@@ -342,10 +342,9 @@ struct ResultRange
 {
 	SafeResultRange safe;
 	alias safe this;
-	deprecated("Usage of Variant is deprecated. Use SafeResultRange instead of ResultRange")
-		inout(Row) front() inout { return inout(Row)(safe.front); }
+	inout(Row) front() inout { return inout(Row)(safe.front); }
 
-	deprecated("Usage of Variant is deprecated. Use SafeResultRange instead of ResultRange")
+	deprecated("Usage of Variant is deprecated. Use safe member to get a SafeResultRange")
 	Variant[string] asAA()
 	{
 		ensureValid();