Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Annotate DbDataReader.GetSchemaTable as nullable #41082

Merged
merged 1 commit into from
Aug 21, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ private DataTable ExecuteCommand(DataRow requestedCollectionRow, string?[]? rest
Locale = CultureInfo.InvariantCulture
};

schemaTable = reader.GetSchemaTable();
schemaTable = reader.GetSchemaTable()!;
foreach (DataRow row in schemaTable.Rows)
{
resultTable.Columns.Add(row["ColumnName"] as string, (Type)row["DataType"]);
Expand Down
10 changes: 5 additions & 5 deletions src/libraries/System.Data.Common/ref/System.Data.Common.cs
Original file line number Diff line number Diff line change
Expand Up @@ -856,7 +856,7 @@ public override void Close() { }
public override System.Type GetProviderSpecificFieldType(int ordinal) { throw null; }
public override object GetProviderSpecificValue(int ordinal) { throw null; }
public override int GetProviderSpecificValues(object[] values) { throw null; }
public override System.Data.DataTable GetSchemaTable() { throw null; }
public override System.Data.DataTable? GetSchemaTable() { throw null; }
public override string GetString(int ordinal) { throw null; }
public override object GetValue(int ordinal) { throw null; }
public override int GetValues(object[] values) { throw null; }
Expand Down Expand Up @@ -1236,7 +1236,7 @@ public partial interface IDataReader : System.Data.IDataRecord, System.IDisposab
bool IsClosed { get; }
int RecordsAffected { get; }
void Close();
System.Data.DataTable GetSchemaTable();
System.Data.DataTable? GetSchemaTable();
bool NextResult();
bool Read();
}
Expand Down Expand Up @@ -1935,7 +1935,7 @@ protected override void Dispose(bool disposing) { }
protected abstract string GetParameterName(int parameterOrdinal);
protected abstract string GetParameterName(string parameterName);
protected abstract string GetParameterPlaceholder(int parameterOrdinal);
protected virtual System.Data.DataTable GetSchemaTable(System.Data.Common.DbCommand sourceCommand) { throw null; }
protected virtual System.Data.DataTable? GetSchemaTable(System.Data.Common.DbCommand sourceCommand) { throw null; }
public System.Data.Common.DbCommand GetUpdateCommand() { throw null; }
public System.Data.Common.DbCommand GetUpdateCommand(bool useColumnsForParameterNames) { throw null; }
protected virtual System.Data.Common.DbCommand InitializeCommand(System.Data.Common.DbCommand? command) { throw null; }
Expand Down Expand Up @@ -2156,8 +2156,8 @@ protected virtual void Dispose(bool disposing) { }
public virtual object GetProviderSpecificValue(int ordinal) { throw null; }
[System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
public virtual int GetProviderSpecificValues(object[] values) { throw null; }
public virtual System.Data.DataTable GetSchemaTable() { throw null; }
public virtual System.Threading.Tasks.Task<System.Data.DataTable> GetSchemaTableAsync(System.Threading.CancellationToken cancellationToken = default) { throw null; }
public virtual System.Data.DataTable? GetSchemaTable() { throw null; }
public virtual System.Threading.Tasks.Task<System.Data.DataTable?> GetSchemaTableAsync(System.Threading.CancellationToken cancellationToken = default) { throw null; }
public virtual System.Threading.Tasks.Task<System.Collections.ObjectModel.ReadOnlyCollection<System.Data.Common.DbColumn>> GetColumnSchemaAsync(System.Threading.CancellationToken cancellationToken = default) { throw null; }
public virtual System.IO.Stream GetStream(int ordinal) { throw null; }
public abstract string GetString(int ordinal);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -646,7 +646,7 @@ private void BuildCache(bool closeConnection, DataRow? dataRow, bool useColumnsF
ADP.BuildSchemaTableInfoTableNames(srcColumnNames);
}

protected virtual DataTable GetSchemaTable(DbCommand sourceCommand)
protected virtual DataTable? GetSchemaTable(DbCommand sourceCommand)
{
using (IDataReader dataReader = sourceCommand.ExecuteReader(CommandBehavior.SchemaOnly | CommandBehavior.KeyInfo))
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,12 +75,13 @@ public virtual ValueTask DisposeAsync()

/// <summary>
/// Returns a <see cref="DataTable" /> that describes the column metadata of the ><see cref="DbDataReader" />.
///
/// Returns <see langword="null" /> if the executed command returned no resultset, or after
/// <see cref="NextResult" /> returns <see langword="false" />.
/// </summary>
/// <returns>A <see cref="DataTable" /> that describes the column metadata.</returns>
/// <exception cref="InvalidOperationException">The <see cref="DbDataReader" /> is closed.</exception>
/// <exception cref="IndexOutOfRangeException">The column index is out of range.</exception>
/// <exception cref="NotSupportedException">.NET Core only: This member is not supported.</exception>
public virtual DataTable GetSchemaTable()
public virtual DataTable? GetSchemaTable()
{
throw new NotSupportedException();
}
Expand All @@ -97,11 +98,11 @@ public virtual DataTable GetSchemaTable()
/// </summary>
/// <param name="cancellationToken">The cancellation instruction.</param>
/// <returns>A task representing the asynchronous operation.</returns>
public virtual Task<DataTable> GetSchemaTableAsync(CancellationToken cancellationToken = default)
public virtual Task<DataTable?> GetSchemaTableAsync(CancellationToken cancellationToken = default)
{
if (cancellationToken.IsCancellationRequested)
{
return Task.FromCanceled<DataTable>(cancellationToken);
return Task.FromCanceled<DataTable?>(cancellationToken);
}

try
Expand All @@ -110,7 +111,7 @@ public virtual Task<DataTable> GetSchemaTableAsync(CancellationToken cancellatio
}
catch (Exception e)
{
return Task.FromException<DataTable>(e);
return Task.FromException<DataTable?>(e);
}
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,12 +73,15 @@ public static bool CanGetColumnSchema(this DbDataReader reader)
private static ReadOnlyCollection<DbColumn> GetColumnSchemaCompatibility(DbDataReader reader)
{
var columnSchema = new List<DbColumn>();
DataTable schemaTable = reader.GetSchemaTable();
DataColumnCollection schemaTableColumns = schemaTable.Columns;
foreach (DataRow row in schemaTable.Rows)
DataTable? schemaTable = reader.GetSchemaTable();
if (schemaTable != null)
{
Debug.Assert(row != null);
columnSchema.Add(new DataRowDbColumn(row, schemaTableColumns));
DataColumnCollection schemaTableColumns = schemaTable.Columns;
foreach (DataRow row in schemaTable.Rows)
{
Debug.Assert(row != null);
columnSchema.Add(new DataRowDbColumn(row, schemaTableColumns));
}
}
return new ReadOnlyCollection<DbColumn>(columnSchema);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ public interface IDataReader : IDisposable, IDataRecord
bool IsClosed { get; }
int RecordsAffected { get; }
void Close();
DataTable GetSchemaTable();
DataTable? GetSchemaTable();
bool NextResult();
bool Read();
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ internal string GetName(int ordinal)
Debug.Assert(null != fieldName, "null GetName");
return ((null != fieldName) ? fieldName : "");
}
internal DataTable GetSchemaTable()
internal DataTable? GetSchemaTable()
{
return _dataReader.GetSchemaTable();
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -516,7 +516,7 @@ public async Task GetSchemaTableAsync_calls_GetSchemaTable()
var readerTable = new DataTable();
readerTable.Columns.Add("text_col", typeof(string));

var table = await new SchemaDbDataReaderMock(readerTable).GetSchemaTableAsync();
var table = (await new SchemaDbDataReaderMock(readerTable).GetSchemaTableAsync())!;

DataRow textColRow = table.Rows.Cast<DataRow>().Single()!;
Assert.Equal("text_col", textColRow["ColumnName"]);
Expand Down
2 changes: 1 addition & 1 deletion src/libraries/System.Data.Odbc/ref/System.Data.Odbc.cs
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ protected override void Dispose(bool disposing) { }
public override long GetInt64(int i) { throw null; }
public override string GetName(int i) { throw null; }
public override int GetOrdinal(string value) { throw null; }
public override System.Data.DataTable GetSchemaTable() { throw null; }
public override System.Data.DataTable? GetSchemaTable() { throw null; }
public override string GetString(int i) { throw null; }
public System.TimeSpan GetTime(int i) { throw null; }
public override object GetValue(int i) { throw null; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -405,12 +405,9 @@ public override string GetDataTypeName(int i)
DbSchemaInfo info = _dataCache.GetSchema(i);
if (info._typename == null)
{
info._typename = GetColAttributeStr(i, ODBC32.SQL_DESC.TYPE_NAME, ODBC32.SQL_COLUMN.TYPE_NAME, ODBC32.HANDLER.THROW);
info._typename = GetColAttributeStr(i, ODBC32.SQL_DESC.TYPE_NAME, ODBC32.SQL_COLUMN.TYPE_NAME, ODBC32.HANDLER.THROW)!;
}
// TODO-NULLABLE: Behavior change probably needed here - when there's no data type, we mostly probably need to throw instead of returning null.
#nullable disable
return info._typename;
#nullable enable
}
throw ADP.DataReaderNoData();
}
Expand Down Expand Up @@ -2245,18 +2242,15 @@ private DataTable NewSchemaTable()
// The default values are already defined in DbSchemaRows (see DbSchemaRows.cs) so there is no need to set any default value
//

public override DataTable GetSchemaTable()
public override DataTable? GetSchemaTable()
{
if (IsClosed)
{ // MDAC 68331
throw ADP.DataReaderClosed("GetSchemaTable"); // can't use closed connection
}
if (_noMoreResults)
{
// TODO-NULLABLE: Behavior change (https://github.com/dotnet/runtime/issues/509)
#nullable disable
return null; // no more results
#nullable enable
}
if (null != _schemaTable)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1101,7 +1101,7 @@ private DataTable NewDataTableFromReader(IDataReader reader, out object[] values
{
DataTable resultTable = new DataTable(tableName);
resultTable.Locale = System.Globalization.CultureInfo.InvariantCulture;
DataTable schemaTable = reader.GetSchemaTable();
DataTable schemaTable = reader.GetSchemaTable()!;
foreach (DataRow row in schemaTable.Rows)
{
resultTable.Columns.Add(row["ColumnName"] as string, (Type)row["DataType"]);
Expand Down
2 changes: 1 addition & 1 deletion src/libraries/System.Data.OleDb/ref/System.Data.OleDb.cs
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ public override void Close() { }
public override long GetInt64(int ordinal) { throw null; }
public override string GetName(int index) { throw null; }
public override int GetOrdinal(string name) { throw null; }
public override System.Data.DataTable GetSchemaTable() { throw null; }
public override System.Data.DataTable? GetSchemaTable() { throw null; }
public override string GetString(int ordinal) { throw null; }
public System.TimeSpan GetTimeSpan(int ordinal) { throw null; }
public override object GetValue(int ordinal) { throw null; }
Expand Down
5 changes: 1 addition & 4 deletions src/libraries/System.Data.OleDb/src/OleDbDataReader.cs
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ private UnsafeNativeMethods.IRow IRow()
return irow;
}

public override DataTable GetSchemaTable()
public override DataTable? GetSchemaTable()
{
DataTable? schemaTable = _dbSchemaTable;
if (null == schemaTable)
Expand All @@ -273,10 +273,7 @@ public override DataTable GetSchemaTable()
//GetSchemaTable() is defined to return null after NextResult returns false
//throw ADP.DataReaderNoData();
}
// TODO-NULLABLE: Behavior change (https://github.com/dotnet/runtime/issues/509)
#nullable disable
return schemaTable;
#nullable enable
}

internal void BuildMetaInfo()
Expand Down