ServantSoftware.Data.Json 1.0.0.193

There is a newer version of this package available.
See the version list below for details.
dotnet add package ServantSoftware.Data.Json --version 1.0.0.193                
NuGet\Install-Package ServantSoftware.Data.Json -Version 1.0.0.193                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="ServantSoftware.Data.Json" Version="1.0.0.193" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ServantSoftware.Data.Json --version 1.0.0.193                
#r "nuget: ServantSoftware.Data.Json, 1.0.0.193"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install ServantSoftware.Data.Json as a Cake Addin
#addin nuget:?package=ServantSoftware.Data.Json&version=1.0.0.193

// Install ServantSoftware.Data.Json as a Cake Tool
#tool nuget:?package=ServantSoftware.Data.Json&version=1.0.0.193                

JSON Data Provider

  • Only use classes from the System.Text.Json namespace to serialize/deserialize JSON. No dependencies on Newtonsoft allowed.
  • Using non-Microsoft libraries requires approval. Minimal dependencies is ideal and if we want/need to bring in other dependencies, those dependencies need to be platform agnostic, royality-free and lean toward unrestrictive licensing such as a MIT license.
  • The connection string is used mainly to determine the data source for the provider. The data source can be either a file path to a folder or to a json file.
    • If a path to a folder, then the folder represents the json database and each json file in the folder represents a table. The file name then becomes the table's name and you can expect that data within the file be a JSON array of objects. For example:
[  
    { "name":"Joe", "email":"Joe@gmail.com", "salary":56000, "married":true },  
    { "name":"Bob", "email":"bob32@gmail.com", "salary":95000 },  
]

In the above example, this table would have 4 columns, one for each unique name/value pair. Note: If is valid that there is not a name/value pair as is seen for the "married" property in the second object. Internally, this object will be represented as having a "married" property of null.

  • If a path to a json file, then the json file represents a database. In that case then, you can expect the format of the file to be an object containing name\value pairs. Each name\value pair represents a table and the value of that pair will a JSON array of objects.
{
  "employees": 
  [  
    { "name":"Joe", "email":"Joe@gmail.com", "salary":56000, "married":true },  
    { "name":"Bob", "email":"bob32@gmail.com", "salary":95000 },  
  ],
  "locations":
  [
    { "city":"Houston", "state":"Texas", "zip":77846 },
    { "city":"New Braunfels", "state":"Texas", "zip":78132 },
  ]
}

The above example would represent a database containing 2 tables. The first table would be named "employees" containing 4 columns. The second table would be named "locations" and contain 3 columns.

  • For determination of the data type of a property of a model, limit the valid data types to string, number (System.Int64 or System.Double depending on the data provided), and boolean (See JSON Data Types) or an IEnumerable<> of any of those data types. Values of type Int64, double and bool, you must determine if any of the properties in the array of objects contains a null value. If so, then the property within the model must be nullable.

    • For determining data type in this flattened structure, if the value of a name/value pair is a JSON object, then assume a data type of string and the value of that column is just the JSON string of the object. A future task (but is not part of the bid on this task) may be to extend this data provider to determine tables based on nested objects within the JSON data structure.
  • Internally for the JsonCommand class, parsing of the IDbCommand.CommandText property should use the Irony library with the SQL Grammar that they have provided.

    • If I were implementing this project, I'd probably load the JSON files into a System.Data.DataSet and use Dynamic Linq and LINQ to DataSet so that it could handle the parsing and syntax trees in the WHERE clause predicates, etc... (instead of doing it in my own code, which I would later have to maintain).
  • JSON comments is to have some support in this data provider. When the Caption property of a DataColumn is set in a DataSet and then the JsonDataAdapter's Update() method is called, that Caption property, if it has been set, (Note: According to the docs, its value will be the name of the Column if it hasn't been set. So ignore that case where Caption == Name.) it will be written within the JSON stored to disk. For example:

{
"key": "value" // comment for this key here.
}

System.Text.Json has some support for this JsonCommentHandling Enum & JsonTokenType.Comment Enum, but no research has been done to determine if it supports writting these comments to disk. When reading the JSON from disk, if multiple rows of a table for a particular column have a comment, it is okay to use just the first occurence of a comment if/when setting the DataColumn's Caption property.

Product Compatible and additional computed target framework versions.
.NET net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on ServantSoftware.Data.Json:

Package Downloads
ServantSoftware.EFCore.Json

Package Description

ServantSoftware.SettingsOnADO.Json

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.0.298 93 a month ago
1.0.0.297 96 a month ago
1.0.0.296 147 2 months ago
1.0.0.295 99 2 months ago
1.0.0.294 164 2 months ago
1.0.0.293 141 2 months ago
1.0.0.289 102 2 months ago
1.0.0.288 122 2 months ago
1.0.0.287 138 2 months ago
1.0.0.286 167 2 months ago
1.0.0.285 94 2 months ago
1.0.0.284 103 2 months ago
1.0.0.283 98 2 months ago
1.0.0.282 94 2 months ago
1.0.0.281 90 2 months ago
1.0.0.280 94 2 months ago
1.0.0.279 111 3 months ago
1.0.0.278 102 3 months ago
1.0.0.277 101 3 months ago
1.0.0.276 110 3 months ago
1.0.0.275 107 3 months ago
1.0.0.274 106 3 months ago
1.0.0.273 106 3 months ago
1.0.0.272 117 3 months ago
1.0.0.271 106 3 months ago
1.0.0.270 110 3 months ago
1.0.0.269 101 3 months ago
1.0.0.268 108 4 months ago
1.0.0.267 102 4 months ago
1.0.0.266 106 4 months ago
1.0.0.265 111 4 months ago
1.0.0.264 111 4 months ago
1.0.0.263 109 4 months ago
1.0.0.262 98 4 months ago
1.0.0.261 106 5 months ago
1.0.0.260 107 5 months ago
1.0.0.259 235 8 months ago
1.0.0.258 501 4/17/2024
1.0.0.257 131 4/17/2024
1.0.0.256 131 4/17/2024
1.0.0.254 128 4/15/2024
1.0.0.253 121 4/15/2024
1.0.0.252 128 4/14/2024
1.0.0.251 119 4/14/2024
1.0.0.250 117 4/13/2024
1.0.0.249 120 4/13/2024
1.0.0.248 119 4/11/2024
1.0.0.247 120 4/11/2024
1.0.0.246 130 4/1/2024
1.0.0.245 130 4/1/2024
1.0.0.242 146 3/27/2024
1.0.0.241 127 3/27/2024
1.0.0.240 154 3/27/2024
1.0.0.239 113 3/27/2024
1.0.0.238 189 3/16/2024
1.0.0.237 131 3/16/2024
1.0.0.236 155 2/14/2024
1.0.0.235 185 12/20/2023
1.0.0.233 296 10/23/2023
1.0.0.232 142 10/23/2023
1.0.0.231 129 10/23/2023
1.0.0.230 125 10/23/2023
1.0.0.229 123 10/23/2023
1.0.0.228 136 10/22/2023
1.0.0.227 125 10/22/2023
1.0.0.226 142 10/22/2023
1.0.0.225 118 10/22/2023
1.0.0.224 130 10/22/2023
1.0.0.223 135 10/22/2023
1.0.0.222 147 10/22/2023
1.0.0.221 133 10/22/2023
1.0.0.220 131 10/21/2023
1.0.0.219 154 10/21/2023
1.0.0.218 136 10/21/2023
1.0.0.217 135 10/21/2023
1.0.0.216 147 10/21/2023
1.0.0.215 139 10/21/2023
1.0.0.214 138 10/21/2023
1.0.0.213 127 10/21/2023
1.0.0.212 125 10/21/2023
1.0.0.211 128 10/20/2023
1.0.0.210 130 10/20/2023
1.0.0.209 147 10/20/2023
1.0.0.208 143 10/20/2023
1.0.0.207 142 10/20/2023
1.0.0.206 154 10/20/2023
1.0.0.205 139 10/20/2023
1.0.0.204 126 10/19/2023
1.0.0.203 131 10/17/2023
1.0.0.202 331 10/10/2023
1.0.0.201 184 10/7/2023
1.0.0.200 146 10/3/2023
1.0.0.199 152 10/2/2023
1.0.0.198 137 10/2/2023
1.0.0.195 172 9/27/2023
1.0.0.194 146 9/27/2023
1.0.0.193 141 9/27/2023
1.0.0.192 129 9/27/2023
1.0.0.191 160 9/26/2023
1.0.0.189 226 9/22/2023
1.0.0.188 144 9/22/2023
1.0.0.187 141 9/22/2023
1.0.0.186 137 9/19/2023
1.0.0.185 276 9/18/2023
1.0.0.184 134 9/17/2023
1.0.0.183 137 9/17/2023
1.0.0.182 125 9/16/2023
1.0.0.181 147 9/15/2023
1.0.0.179 175 9/14/2023
1.0.0.178 162 9/14/2023
1.0.0.176 152 9/13/2023
1.0.0.175 147 9/9/2023
1.0.0.174 168 9/8/2023
1.0.0.173 154 9/1/2023
1.0.0.172 166 9/1/2023
1.0.0.171 161 8/31/2023
1.0.0.170 177 8/25/2023
1.0.0.169 156 8/24/2023