Skip to content

Commit d765b85

Browse files
teo-tsirpanisteo-tsirpanis
authoredNov 8, 2022
Add C#-friendly enum value names. (#131)
* Add C#-friendly names to enums. * Obsolete the old `TILEDB_` enum values. * Use the new enum values throughout the codebase. * Make `Status` internal. No public API accepts or returns it, there is no reason for it to be public. * Document the enums and their values. * Remove a blank line. * Fix typo. * Deprecate the EnumUtil methods that accept the low-level enum types. * Suppress obsolete warnings. * Move away from the old EnumUtil methods. * Hide the EnumUtil methods that convert between strings and enums. * Document EnumUtil and make Constants static. * Deprecate `Constants.TILEDB_VAR_NUM` and replace it with `VariableSized` in `Attribute` and `Dimension`.
·
5.17.05.3.0
1 parent 93ac6d8 commit d765b85

33 files changed

+1168
-562
lines changed
 

‎examples/TileDB.CSharp.Example/ExampleGroup.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ public void NestGroup(string pathOrBucket, string parentGroupName, string childG
9090
}
9191

9292
var parentGroup = new Group(_ctx, parentGroupURI);
93-
parentGroup.Open(QueryType.TILEDB_WRITE);
93+
parentGroup.Open(QueryType.Write);
9494
parentGroup.AddMember(childGroupURI, false, "groupMember2");
9595
parentGroup.Close();
9696
}

‎examples/TileDB.CSharp.Example/ExampleIncompleteQuery.cs

+7-7
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ private static void CreateArray()
2424
domain.AddDimension(dim1);
2525
domain.AddDimension(dim2);
2626

27-
var schema = new ArraySchema(Ctx, ArrayType.TILEDB_SPARSE);
27+
var schema = new ArraySchema(Ctx, ArrayType.Sparse);
2828
schema.SetDomain(domain);
2929

30-
var attr = new Attribute(Ctx, "a1", DataType.TILEDB_INT32);
30+
var attr = new Attribute(Ctx, "a1", DataType.Int32);
3131
schema.AddAttribute(attr);
3232
schema.Check();
3333

@@ -54,10 +54,10 @@ from b in Enumerable.Range(1, 10)
5454
int[] attrData = Enumerable.Range(1, 100).ToArray();
5555
using (var arrayWrite = new Array(Ctx, ArrayPath))
5656
{
57-
arrayWrite.Open(QueryType.TILEDB_WRITE);
57+
arrayWrite.Open(QueryType.Write);
5858

5959
var queryWrite = new Query(Ctx, arrayWrite);
60-
queryWrite.SetLayout(LayoutType.TILEDB_UNORDERED);
60+
queryWrite.SetLayout(LayoutType.Unordered);
6161
queryWrite.SetDataBuffer<int>("rows", rowsData);
6262
queryWrite.SetDataBuffer<int>("cols", colsData);
6363
queryWrite.SetDataBuffer<int>("a1", attrData);
@@ -77,9 +77,9 @@ private static void ReadArray()
7777

7878
using (var arrayRead = new Array(Ctx, ArrayPath))
7979
{
80-
arrayRead.Open(QueryType.TILEDB_READ);
80+
arrayRead.Open(QueryType.Read);
8181
var queryRead = new Query(Ctx, arrayRead);
82-
queryRead.SetLayout(LayoutType.TILEDB_UNORDERED);
82+
queryRead.SetLayout(LayoutType.Unordered);
8383
queryRead.SetSubarray(new[] { 1, 100, 1, 100 });
8484

8585
queryRead.SetDataBuffer<int>("rows", rowsRead);
@@ -101,7 +101,7 @@ private static void ReadArray()
101101
Console.WriteLine($"Batch #{batchNum++}: {string.Join(", ", resultList)}");
102102

103103
// If read is still incomplete, submit query again using allocated buffers
104-
} while (queryRead.Status() == QueryStatus.TILEDB_INCOMPLETE);
104+
} while (queryRead.Status() == QueryStatus.Incomplete);
105105

106106
Console.WriteLine($"Final read query status: {queryRead.Status()}");
107107
arrayRead.Close();

‎examples/TileDB.CSharp.Example/ExampleIncompleteQueryStringDimensions.cs

+7-7
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ private static void CreateArray()
1919
var domain = new Domain(Ctx);
2020
domain.AddDimensions(rows, cols);
2121

22-
var schema = new ArraySchema(Ctx, ArrayType.TILEDB_SPARSE);
22+
var schema = new ArraySchema(Ctx, ArrayType.Sparse);
2323
schema.SetDomain(domain);
2424

25-
var attr = new Attribute(Ctx, "a1", DataType.TILEDB_INT32);
25+
var attr = new Attribute(Ctx, "a1", DataType.Int32);
2626
schema.AddAttribute(attr);
2727
schema.Check();
2828

@@ -41,10 +41,10 @@ private static void WriteArray()
4141

4242
using (var arrayWrite = new Array(Ctx, ArrayPath))
4343
{
44-
arrayWrite.Open(QueryType.TILEDB_WRITE);
44+
arrayWrite.Open(QueryType.Write);
4545

4646
var queryWrite = new Query(Ctx, arrayWrite);
47-
queryWrite.SetLayout(LayoutType.TILEDB_UNORDERED);
47+
queryWrite.SetLayout(LayoutType.Unordered);
4848
queryWrite.SetDataBuffer("rows", rowsData);
4949
queryWrite.SetOffsetsBuffer("rows", rowsOffsets);
5050
queryWrite.SetDataBuffer("cols", colsData);
@@ -61,9 +61,9 @@ private static void ReadArray()
6161
{
6262
using (var arrayRead = new Array(Ctx, ArrayPath))
6363
{
64-
arrayRead.Open(QueryType.TILEDB_READ);
64+
arrayRead.Open(QueryType.Read);
6565
var queryRead = new Query(Ctx, arrayRead);
66-
queryRead.SetLayout(LayoutType.TILEDB_UNORDERED);
66+
queryRead.SetLayout(LayoutType.Unordered);
6767
queryRead.AddRange("rows", "a", "eeeee");
6868
queryRead.AddRange("cols", "f", "jjjjj");
6969

@@ -127,7 +127,7 @@ private static void ReadArray()
127127
Console.WriteLine($"Batch #{batchNum++}: {string.Join(", ", resultList)}");
128128

129129
// If read is still incomplete, submit query again using allocated buffers
130-
} while (queryRead.Status() == QueryStatus.TILEDB_INCOMPLETE);
130+
} while (queryRead.Status() == QueryStatus.Incomplete);
131131

132132
Console.WriteLine($"Final read query status: {queryRead.Status()}");
133133
arrayRead.Close();

‎examples/TileDB.CSharp.Example/ExampleQuery.cs

+8-8
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ private static void CreateArray()
2020
var domain = new Domain(Ctx);
2121
domain.AddDimension(dim1);
2222
domain.AddDimension(dim2);
23-
var array_schema = new ArraySchema(Ctx, ArrayType.TILEDB_SPARSE);
24-
var attr = new Attribute(Ctx, "a", DataType.TILEDB_INT32);
23+
var array_schema = new ArraySchema(Ctx, ArrayType.Sparse);
24+
var attr = new Attribute(Ctx, "a", DataType.Int32);
2525
array_schema.AddAttribute(attr);
2626
array_schema.SetDomain(domain);
2727
array_schema.Check();
@@ -38,9 +38,9 @@ private static void WriteArray()
3838

3939
using (var array_write = new Array(Ctx, ArrayPath))
4040
{
41-
array_write.Open(QueryType.TILEDB_WRITE);
41+
array_write.Open(QueryType.Write);
4242
var query_write = new Query(Ctx, array_write);
43-
query_write.SetLayout(LayoutType.TILEDB_UNORDERED);
43+
query_write.SetLayout(LayoutType.Unordered);
4444
query_write.SetDataBuffer<int>("rows", dim1_data_buffer);
4545
query_write.SetDataBuffer<int>("cols", dim2_data_buffer);
4646
query_write.SetDataBuffer<int>("a", attr_data_buffer);
@@ -58,9 +58,9 @@ private static void ReadArray()
5858

5959
using (var array_read = new Array(Ctx, ArrayPath))
6060
{
61-
array_read.Open(QueryType.TILEDB_READ);
61+
array_read.Open(QueryType.Read);
6262
var query_read = new Query(Ctx, array_read);
63-
query_read.SetLayout(LayoutType.TILEDB_ROW_MAJOR);
63+
query_read.SetLayout(LayoutType.RowMajor);
6464
query_read.SetDataBuffer<int>("rows", dim1_data_buffer_read);
6565
query_read.SetDataBuffer<int>("cols", dim2_data_buffer_read);
6666
query_read.SetDataBuffer<int>("a", attr_data_buffer_read);
@@ -85,9 +85,9 @@ private static void ReadArrayAsync()
8585
var attr_data_buffer_read = new int[3];
8686

8787
var array_read = new Array(Ctx, ArrayPath);
88-
array_read.Open(QueryType.TILEDB_READ);
88+
array_read.Open(QueryType.Read);
8989
var query_read = new Query(Ctx, array_read);
90-
query_read.SetLayout(LayoutType.TILEDB_ROW_MAJOR);
90+
query_read.SetLayout(LayoutType.RowMajor);
9191
query_read.SetDataBuffer<int>("rows", dim1_data_buffer_read);
9292
query_read.SetDataBuffer<int>("cols", dim2_data_buffer_read);
9393
query_read.SetDataBuffer<int>("a", attr_data_buffer_read);

‎examples/TileDB.CSharp.Example/ExampleWritingDenseGlobal.cs

+6-6
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ private static void CreateArray()
1616
domain.AddDimension(Dimension.Create(Ctx, "rows", 1, 4, 2));
1717
domain.AddDimension(Dimension.Create(Ctx, "cols", 1, 4, 2));
1818

19-
using var schema = new ArraySchema(Ctx, ArrayType.TILEDB_DENSE);
19+
using var schema = new ArraySchema(Ctx, ArrayType.Dense);
2020
Console.WriteLine($"Tile order: {schema.TileOrder()}; Cell order: {schema.CellOrder()}");
2121
schema.SetDomain(domain);
2222
schema.AddAttribute(Attribute.Create<int>(Ctx, "a1"));
@@ -27,10 +27,10 @@ private static void CreateArray()
2727
private static void WriteArray()
2828
{
2929
using var array = new Array(Ctx, ArrayPath);
30-
array.Open(QueryType.TILEDB_WRITE);
30+
array.Open(QueryType.Write);
3131

32-
using var queryWrite = new Query(Ctx, array, QueryType.TILEDB_WRITE);
33-
queryWrite.SetLayout(LayoutType.TILEDB_GLOBAL_ORDER);
32+
using var queryWrite = new Query(Ctx, array, QueryType.Write);
33+
queryWrite.SetLayout(LayoutType.GlobalOrder);
3434
// Slice rows 1-4, columns 1-2 for a total of 8 cells
3535
queryWrite.AddRange("rows", 1, 4);
3636
queryWrite.AddRange("cols", 1, 2);
@@ -53,8 +53,8 @@ private static void WriteArray()
5353
private static void ReadArray()
5454
{
5555
using var array = new Array(Ctx, ArrayPath);
56-
array.Open(QueryType.TILEDB_READ);
57-
using var readQuery = new Query(Ctx, array, QueryType.TILEDB_READ);
56+
array.Open(QueryType.Read);
57+
using var readQuery = new Query(Ctx, array, QueryType.Read);
5858
readQuery.SetSubarray(new[] { 1, 4, 1, 4 });
5959

6060
var a1Read = new int[16];

‎examples/TileDB.CSharp.Example/ExampleWritingSparseGlobal.cs

+6-6
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ private static void CreateArray()
1717
domain.AddDimension(Dimension.Create(Ctx, "rows", 1, 4, 2));
1818
domain.AddDimension(Dimension.Create(Ctx, "cols", 1, 4, 2));
1919

20-
using var schema = new ArraySchema(Ctx, ArrayType.TILEDB_SPARSE);
20+
using var schema = new ArraySchema(Ctx, ArrayType.Sparse);
2121
Console.WriteLine($"Tile order: {schema.TileOrder()}; Cell order: {schema.CellOrder()}");
2222
schema.SetDomain(domain);
2323
schema.AddAttribute(Attribute.Create<int>(Ctx, "a1"));
@@ -28,9 +28,9 @@ private static void CreateArray()
2828
private static void WriteArray()
2929
{
3030
using var array = new Array(Ctx, ArrayPath);
31-
array.Open(QueryType.TILEDB_WRITE);
32-
using var queryWrite = new Query(Ctx, array, QueryType.TILEDB_WRITE);
33-
queryWrite.SetLayout(LayoutType.TILEDB_GLOBAL_ORDER);
31+
array.Open(QueryType.Write);
32+
using var queryWrite = new Query(Ctx, array, QueryType.Write);
33+
queryWrite.SetLayout(LayoutType.GlobalOrder);
3434

3535
// Coordinates for global order writes must be provided in-order
3636
// + We may not write to (2, 1) before (1, 1); (2, 1) comes after (1, 1) in global order
@@ -56,8 +56,8 @@ private static void WriteArray()
5656
private static void ReadArray()
5757
{
5858
using var array = new Array(Ctx, ArrayPath);
59-
array.Open(QueryType.TILEDB_READ);
60-
using var readQuery = new Query(Ctx, array, QueryType.TILEDB_READ);
59+
array.Open(QueryType.Read);
60+
using var readQuery = new Query(Ctx, array, QueryType.Read);
6161
readQuery.SetSubarray(new[] { 1, 4, 1, 4 });
6262

6363
var rowsRead = new int[6];

‎notebooks/array_metadata.ipynb

+4-4
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@
4444
"var dim2 = TileDB.CSharp.Dimension.Create<int>(ctx,\"cols\",1,4,4);\n",
4545
"dom.AddDimension(dim1);\n",
4646
"dom.AddDimension(dim2);\n",
47-
"var schema = new TileDB.CSharp.ArraySchema(ctx,TileDB.CSharp.ArrayType.TILEDB_DENSE);\n",
47+
"var schema = new TileDB.CSharp.ArraySchema(ctx,TileDB.CSharp.ArrayType.Dense);\n",
4848
"schema.SetDomain(dom);\n",
49-
"var attr1 = new TileDB.CSharp.Attribute(ctx,\"a\",TileDB.CSharp.DataType.TILEDB_INT32);\n",
49+
"var attr1 = new TileDB.CSharp.Attribute(ctx,\"a\",TileDB.CSharp.DataType.Int32);\n",
5050
"schema.AddAttribute(attr1);\n",
5151
"string array_uri = \"test_metadata_array\";\n",
5252
"var vfs = new TileDB.CSharp.VFS(ctx);\n",
@@ -76,7 +76,7 @@
7676
"source": [
7777
"using(var array_write = new TileDB.CSharp.Array(ctx,array_uri)) \n",
7878
"{\n",
79-
" array_write.Open(TileDB.CSharp.QueryType.TILEDB_WRITE);\n",
79+
" array_write.Open(TileDB.CSharp.QueryType.Write);\n",
8080
" var int_metadata = new int[2] {1,100};\n",
8181
" array_write.PutMetadata<int>(\"int_metadata\",int_metadata);\n",
8282
" var double_metadata = new double[3] {1.0,100.0,1000.0};\n",
@@ -106,7 +106,7 @@
106106
"outputs": [],
107107
"source": [
108108
"var array_read = new TileDB.CSharp.Array(ctx,array_uri);\n",
109-
"array_read.Open(TileDB.CSharp.QueryType.TILEDB_READ);"
109+
"array_read.Open(TileDB.CSharp.QueryType.Read);"
110110
]
111111
},
112112
{

‎notebooks/group.ipynb

+8-8
Original file line numberDiff line numberDiff line change
@@ -68,14 +68,14 @@
6868
" var dim_1 = TileDB.CSharp.Dimension.Create(context, \"d1\", new[] { 1, 1 }, 1);\n",
6969
" domain.AddDimension(dim_1);\n",
7070
"\n",
71-
" var array_schema = new TileDB.CSharp.ArraySchema(context, TileDB.CSharp.ArrayType.TILEDB_DENSE);\n",
71+
" var array_schema = new TileDB.CSharp.ArraySchema(context, TileDB.CSharp.ArrayType.Dense);\n",
7272
"\n",
73-
" var attr1 = new TileDB.CSharp.Attribute(context, \"a1\", TileDB.CSharp.DataType.TILEDB_FLOAT32);\n",
73+
" var attr1 = new TileDB.CSharp.Attribute(context, \"a1\", TileDB.CSharp.DataType.Float32);\n",
7474
" array_schema.AddAttribute(attr1);\n",
7575
"\n",
7676
" array_schema.SetDomain(domain);\n",
77-
" array_schema.SetCellOrder(TileDB.CSharp.LayoutType.TILEDB_ROW_MAJOR);\n",
78-
" array_schema.SetTileOrder(TileDB.CSharp.LayoutType.TILEDB_ROW_MAJOR);\n",
77+
" array_schema.SetCellOrder(TileDB.CSharp.LayoutType.RowMajor);\n",
78+
" array_schema.SetTileOrder(TileDB.CSharp.LayoutType.RowMajor);\n",
7979
"\n",
8080
" array_schema.Check();\n",
8181
"\n",
@@ -166,9 +166,9 @@
166166
"outputs": [],
167167
"source": [
168168
"var group1 = new TileDB.CSharp.Group(ctx,group1_uri);\n",
169-
"group1.Open(TileDB.CSharp.QueryType.TILEDB_WRITE);\n",
169+
"group1.Open(TileDB.CSharp.QueryType.Write);\n",
170170
"var group2 = new TileDB.CSharp.Group(ctx,group2_uri);\n",
171-
"group2.Open(TileDB.CSharp.QueryType.TILEDB_WRITE);\n",
171+
"group2.Open(TileDB.CSharp.QueryType.Write);\n",
172172
"group1.AddMember(array1_uri,false);\n",
173173
"group1.AddMember(array2_uri,false);\n",
174174
"group2.AddMember(array3_uri,false);\n",
@@ -194,10 +194,10 @@
194194
"outputs": [],
195195
"source": [
196196
"var group = new TileDB.CSharp.Group(ctx,group1_uri);\n",
197-
"group.Open(TileDB.CSharp.QueryType.TILEDB_WRITE);\n",
197+
"group.Open(TileDB.CSharp.QueryType.Write);\n",
198198
"group.PutMetadata<int>(\"key1\",10);\n",
199199
"group.Close();\n",
200-
"group.Open(TileDB.CSharp.QueryType.TILEDB_READ);\n",
200+
"group.Open(TileDB.CSharp.QueryType.Read);\n",
201201
"var v1 = group.GetMetadata<int>(\"key1\");\n",
202202
"System.Console.WriteLine(\"v1:{0}\", v1);"
203203
]

‎notebooks/quickstart_dense.ipynb

+6-6
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,9 @@
6969
},
7070
"outputs": [],
7171
"source": [
72-
"var schema = new TileDB.CSharp.ArraySchema(ctx,TileDB.CSharp.ArrayType.TILEDB_DENSE);\n",
72+
"var schema = new TileDB.CSharp.ArraySchema(ctx,TileDB.CSharp.ArrayType.Dense);\n",
7373
"schema.SetDomain(dom);\n",
74-
"var attr1 = new TileDB.CSharp.Attribute(ctx,\"a\",TileDB.CSharp.DataType.TILEDB_INT32);\n",
74+
"var attr1 = new TileDB.CSharp.Attribute(ctx,\"a\",TileDB.CSharp.DataType.Int32);\n",
7575
"schema.AddAttribute(attr1);"
7676
]
7777
},
@@ -169,9 +169,9 @@
169169
"outputs": [],
170170
"source": [
171171
"using (var array_write = new TileDB.CSharp.Array(ctx,array_uri)) {\n",
172-
" array_write.Open(TileDB.CSharp.QueryType.TILEDB_WRITE);\n",
172+
" array_write.Open(TileDB.CSharp.QueryType.Write);\n",
173173
" var query_write = new TileDB.CSharp.Query(ctx,array_write);\n",
174-
" query_write.SetLayout(TileDB.CSharp.LayoutType.TILEDB_ROW_MAJOR);\n",
174+
" query_write.SetLayout(TileDB.CSharp.LayoutType.RowMajor);\n",
175175
" query_write.SetDataBuffer<int>(\"a\",data);\n",
176176
" query_write.Submit();\n",
177177
" array_write.Close();\n",
@@ -225,9 +225,9 @@
225225
"source": [
226226
"using (var array_read = new TileDB.CSharp.Array(ctx,array_uri)) \n",
227227
"{\n",
228-
" array_read.Open(TileDB.CSharp.QueryType.TILEDB_READ);\n",
228+
" array_read.Open(TileDB.CSharp.QueryType.Read);\n",
229229
" var query_read = new TileDB.CSharp.Query(ctx,array_read);\n",
230-
" query_read.SetLayout(TileDB.CSharp.LayoutType.TILEDB_ROW_MAJOR);\n",
230+
" query_read.SetLayout(TileDB.CSharp.LayoutType.RowMajor);\n",
231231
" query_read.SetSubarray<int>(subarray);\n",
232232
" query_read.SetDataBuffer<int>(\"a\",data_read);\n",
233233
" query_read.Submit();\n",

0 commit comments

Comments
 (0)
Please sign in to comment.