Stupeflask Documentation

Total Page:16

File Type:pdf, Size:1020Kb

Stupeflask Documentation Stupeflask Documentation Numberly Jan 20, 2020 Contents 1 Install 3 2 Comparison 5 3 Tests 7 4 License 9 5 Documentation 11 5.1 Better application defaults........................................ 11 5.2 Easier collection of configuration values................................. 13 5.3 Native ObjectId support......................................... 13 5.4 API Reference.............................................. 14 5.5 Cursor support.............................................. 18 6 Indices and tables 19 Python Module Index 21 Index 23 i ii Stupeflask Documentation a.k.a. « Flask on steroids » An opinionated Flask extension designed by and for web developers to reduce boilerplate code when working with Marshmallow, MongoDB and/or JSON. Documentation: https://flask-stupe.readthedocs.io • Return any object type in views, and it will be coerced to a flask.Response • Validate payloads through Marshmallow schemas • Easily add JSON converters for any custom type • Fetch all the blueprints from a whole module in one line • Native ObjectId support for both Flask and Marshmallow • Powerful configuration management • Decorators to handle authentication, permissions, and pagination • 100% coverage and no dependency Contents 1 Stupeflask Documentation 2 Contents CHAPTER 1 Install $ pip install flask-stupe 3 Stupeflask Documentation 4 Chapter 1. Install CHAPTER 2 Comparison Here is a comparison of a bare Flask application and its equivalent Stupeflask version. They both rely on MongoDB, handle input and output in JSON, and allow to create a user and retrieve one or more. 5 Stupeflask Documentation Bare Flask With Stupeflask from bson import ObjectId from flask import request from flask import abort, Flask, jsonify, from flask_stupe import paginate, schema_ ,!request ,!required from marshmallow import Schema from flask_stupe.json import Stupeflask from marshmallow.fields import String from marshmallow import Schema from pymongo import MongoClient from marshmallow.fields import String from pymongo import MongoClient app= Flask(__name__) users= MongoClient().database.users app= Stupeflask(__name__) users= MongoClient().database.users class UserSchema(Schema): username= String(required=True) class UserSchema(Schema): password= String() username= String(required=True) password= String() @app.route("/user", methods=["POST"]) def post_user(): @app.route("/user", methods=["POST"]) json= request.get_json(force=True) @schema_required(UserSchema()) validation_result= UserSchema(). def post_user(): ,!load(json) result= users.insert_one(request. if validation_result.errors: ,!schema) abort(400, validation_result. request.schema.update(_id=result. ,!errors) ,!inserted_id) result= users.insert_one(validation_ return request.schema ,!result.data) inserted_id= str(result.inserted_id) validation_result.data.update(_ @app.route("/user/<ObjectId:id>") ,!id=inserted_id) def get_user(id): return jsonify(validation_result. return users.find_one({"_id": id}) ,!data) @app.route("/users") @app.route("/user/<id>") @paginate(limit=100) def get_user(id): def get_users(): try: return users.find() id= ObjectId(id) except ValueError: abort(404) user= users.find_one({"_id": id}) user["_id"]= str(user["_id"]) return jsonify(user) @app.route("/users") def get_users(): limit= request.args.get("limit", ,!100, type=int) skip= request.args.get("skip",0, ,!type=int) cursor= users.find().limit(limit). ,!skip(skip) return jsonify(list(cursor)) 6 Chapter 2. Comparison CHAPTER 3 Tests To run Flask-Stupe tests: • install developers requirements with pip install -r requirements.txt; • run pytest. 7 Stupeflask Documentation 8 Chapter 3. Tests CHAPTER 4 License MIT 9 Stupeflask Documentation 10 Chapter 4. License CHAPTER 5 Documentation 5.1 Better application defaults Stupeflask makes it easy to use JSON to build APIs. A perfect example is the flask_stupe.json.Stupeflask application. 5.1.1 Better support for JSON based APIs Automatic conversion to JSON By using the JSON version of Stupeflask, every Python object your views returns that is not a Response object will be JSON serialized. With that in mind, you can do that kind of things: @app.route("/foo") def foo(): return {"foo":"bar"} This will be rendered as the equivalent JSON and sent to the client. Add JSON encoding for objects If you want to add serialization methods for other custom types, you can! You’ll need to call JSONEncoder. add_rule(). import uuid app.json_encoder.add_rule(uuid.UUID, lambda uuid: str(uuid)) This snippet shows how to add a serializer for UUIDs. 11 Stupeflask Documentation 5.1.2 Import all blueprints from a package You can easily add a bunch of blueprints by passing a package to the Stupeflask.register_blueprints(). It will search through all the package’s modules and import a variable named like the module. If this is a blueprint, it will be registered into the application. For example, this snippet: from application.views.user import user from application.views.pets import pets from application.views.family import family app.register_blueprint(user) app.register_blueprint(pets) app.register_blueprint(family) Becomes: from application import views app.register_blueprints(views) Metadata wrapping By default, returning {"foo": "bar"} from a route would produce such a response: { "code": 200, "data":{ "foo": "bar" } } As you can see, the data is wrapped within another JSON object containing the status code. You can add more metadata to that outter JSON object by modifying the metadata dictionary of the current flask. request. For example, this snippet will make all responses have a version field added to them: from flask import request @app.before_request def before_request(response): request.metadata.update(version="v1") The produced output will thus look like this: { "code": 200, "data":{ "foo": "bar" }, "version": "v1" } If, on the opposite, you don’t want any sort of metadata wrapping, and rather return a plain {"foo": "bar"} JSON object, just set the METADATA_WRAPPING configuration value to False. 12 Chapter 5. Documentation Stupeflask Documentation 5.1.3 Add path converters With Stupeflask, you can add path converters with Stupeflask.register_converter(). Please head towards werkzeug’s documentation about converters if you want to learn more. 5.2 Easier collection of configuration values Stupeflask makes it easier to collect configuration variables from different sources. 5.2.1 config.py If a file named config.py is present in the working directory, it will be imported and used as the configuration file for your application. 5.2.2 $CONFIG If an environment variable named CONFIG exists, its value will be imported as a Python configuration file. 5.2.3 Environment Any key present in the configuration at this point will be checked in the environment. If a corresponding variable is found in the environment, its value will override the current configuration. Since all environment variables are strings, the value will be cast in the type of the value present in the configuration in the first place. Let’s say you have a variable like so in the config.py file: DEBUG= True You can override it by putting that in the environment: DEBUG=1 In your code, it will not be treated a string or an integer, but as True, because Stupeflask will have detected that it was a boolean and cast it. If you want to invoke this behavior at another moment, use the from_env method. 5.3 Native ObjectId support The bson.ObjectId type is natively supported by Stupeflask. 5.3.1 Path parameter Stupeflask recognizes ObjectIds in path parameters. You can use it like this: @app.route("/user/<ObjectId:id>") 5.2. Easier collection of configuration values 13 Stupeflask Documentation 5.3.2 JSON Any ObjectIds a in JSON response will be coerced to string automaticaly. 5.3.3 Marshmallow field Stupeflask features a field (ObjectId) for ObjectIds. If the bson module exists (for example if you’re using MongoDB), you can use it with schema_required(). It allows to automaticaly cast indicated fields from string to ObjectId. 5.4 API Reference 5.4.1 App class flask_stupe.app.Stupeflask(*args, **kwargs) config_class alias of flask_stupe.config.Config register_blueprints(package, **options) Auto-discover blueprints and register them It will look recursively in every module of the package to find a variable that has the same name as its module. It means that if a file called foo.py has an exportable variable called foo, it will try to register that variable as a blueprint. register_converter(converter, name=None) Register a new converter that can be used in endpoints URLs A converter is a Werkzeug class that transforms a part of an URL to a Python object, passed as an argument to the endpoint function. Stupeflask currently implements the following converters: • /<ObjectId>/ with ::ObjectIdConverter See Werkzeug documentation about custom converters if you want to implement your own converter. register_converters(converter_list) Register multiple converters at once. See register_converter(). request_class alias of flask_stupe.request.Request 5.4.2 Auth flask_stupe.auth.auth_required(function) Decorator checking that the request is made by an authenticated user. If you want to use that function, you should set a before_request handler that authenticate requests when possi- ble. It must then expose a user attribute on the flask.request object. 14 Chapter 5. Documentation Stupeflask Documentation @app.before_request def get_user(): token= request.args.get("token") if verify_token(token): request.user={"username":"toto"} A view decorated with auth_required() will be aborted with a status code 401 if the
Recommended publications
  • Document Databases, JSON, Mongodb 17
    MI-PDB, MIE-PDB: Advanced Database Systems http://www.ksi.mff.cuni.cz/~svoboda/courses/2015-2-MIE-PDB/ Lecture 13: Document Databases, JSON, MongoDB 17. 5. 2016 Lecturer: Martin Svoboda [email protected] Authors: Irena Holubová, Martin Svoboda Faculty of Mathematics and Physics, Charles University in Prague Course NDBI040: Big Data Management and NoSQL Databases Document Databases Basic Characteristics Documents are the main concept Stored and retrieved XML, JSON, … Documents are Self-describing Hierarchical tree data structures Can consist of maps, collections, scalar values, nested documents, … Documents in a collection are expected to be similar Their schema can differ Document databases store documents in the value part of the key-value store Key-value stores where the value is examinable Document Databases Suitable Use Cases Event Logging Many different applications want to log events Type of data being captured keeps changing Events can be sharded by the name of the application or type of event Content Management Systems, Blogging Platforms Managing user comments, user registrations, profiles, web-facing documents, … Web Analytics or Real-Time Analytics Parts of the document can be updated New metrics can be easily added without schema changes E-Commerce Applications Flexible schema for products and orders Evolving data models without expensive data migration Document Databases When Not to Use Complex Transactions Spanning Different Operations Atomic cross-document operations Some document databases do support (e.g., RavenDB) Queries against Varying Aggregate Structure Design of aggregate is constantly changing → we need to save the aggregates at the lowest level of granularity i.e., to normalize the data Document Databases Representatives Lotus Notes Storage Facility JSON JavaScript Object Notation Introduction • JSON = JavaScript Object Notation .
    [Show full text]
  • Smart Grid Serialization Comparison
    Downloaded from orbit.dtu.dk on: Sep 28, 2021 Smart Grid Serialization Comparison Petersen, Bo Søborg; Bindner, Henrik W.; You, Shi; Poulsen, Bjarne Published in: Computing Conference 2017 Link to article, DOI: 10.1109/SAI.2017.8252264 Publication date: 2017 Document Version Peer reviewed version Link back to DTU Orbit Citation (APA): Petersen, B. S., Bindner, H. W., You, S., & Poulsen, B. (2017). Smart Grid Serialization Comparison. In Computing Conference 2017 (pp. 1339-1346). IEEE. https://doi.org/10.1109/SAI.2017.8252264 General rights Copyright and moral rights for the publications made accessible in the public portal are retained by the authors and/or other copyright owners and it is a condition of accessing publications that users recognise and abide by the legal requirements associated with these rights. Users may download and print one copy of any publication from the public portal for the purpose of private study or research. You may not further distribute the material or use it for any profit-making activity or commercial gain You may freely distribute the URL identifying the publication in the public portal If you believe that this document breaches copyright please contact us providing details, and we will remove access to the work immediately and investigate your claim. Computing Conference 2017 18-20 July 2017 | London, UK Smart Grid Serialization Comparision Comparision of serialization for distributed control in the context of the Internet of Things Bo Petersen, Henrik Bindner, Shi You Bjarne Poulsen DTU Electrical Engineering DTU Compute Technical University of Denmark Technical University of Denmark Lyngby, Denmark Lyngby, Denmark [email protected], [email protected], [email protected] [email protected] Abstract—Communication between DERs and System to ensure that the control messages are received within a given Operators is required to provide Demand Response and solve timeframe, depending on the needs of the power grid.
    [Show full text]
  • Spindle Documentation Release 2.0.0
    spindle Documentation Release 2.0.0 Jorge Ortiz, Jason Liszka June 08, 2016 Contents 1 Thrift 3 1.1 Data model................................................3 1.2 Interface definition language (IDL)...................................4 1.3 Serialization formats...........................................4 2 Records 5 2.1 Creating a record.............................................5 2.2 Reading/writing records.........................................6 2.3 Record interface methods........................................6 2.4 Other methods..............................................7 2.5 Mutable trait...............................................7 2.6 Raw class.................................................7 2.7 Priming..................................................7 2.8 Proxies..................................................8 2.9 Reflection.................................................8 2.10 Field descriptors.............................................8 3 Custom types 9 3.1 Enhanced types..............................................9 3.2 Bitfields..................................................9 3.3 Type-safe IDs............................................... 10 4 Enums 13 4.1 Enum value methods........................................... 13 4.2 Companion object methods....................................... 13 4.3 Matching and unknown values...................................... 14 4.4 Serializing to string............................................ 14 4.5 Examples................................................. 14 5 Working
    [Show full text]
  • Rdf Repository Replacing Relational Database
    RDF REPOSITORY REPLACING RELATIONAL DATABASE 1B.Srinivasa Rao, 2Dr.G.Appa Rao 1,2Department of CSE, GITAM University Email:[email protected],[email protected] Abstract-- This study is to propose a flexible enable it. One such technology is RDF (Resource information storage mechanism based on the Description Framework)[2]. RDF is a directed, principles of Semantic Web that enables labelled graph for representing information in the information to be searched rather than queried. Web. This can be perceived as a repository In this study, a prototype is developed where without any predefined structure the focus is on the information rather than the The information stored in the traditional structure. Here information is stored in a RDBMS’s requires structure to be defined structure that is constructed on the fly. Entities upfront. On the contrary, information could be in the system are connected and form a graph, very complex to structure upfront despite the similar to the web of data in the Internet. This tremendous potential offered by the existing data is persisted in a peculiar way to optimize database systems. In the ever changing world, querying on this graph of data. All information another important characteristic of information relating to a subject is persisted closely so that in a system that impacts its structure is the reqeusting any information of a subject could be modification/enhancement to the system. This is handled in one call. Also, the information is a big concern with many software systems that maintained in triples so that the entire exist today and there is no tidy approach to deal relationship from subject to object via the with the problem.
    [Show full text]
  • CBOR (RFC 7049) Concise Binary Object Representation
    CBOR (RFC 7049) Concise Binary Object Representation Carsten Bormann, 2015-11-01 1 CBOR: Agenda • What is it, and when might I want it? • How does it work? • How do I work with it? 2 CBOR: Agenda • What is it, and when might I want it? • How does it work? • How do I work with it? 3 Slide stolen from Douglas Crockford History of Data Formats • Ad Hoc • Database Model • Document Model • Programming Language Model Box notation TLV 5 XML XSD 6 Slide stolen from Douglas Crockford JSON • JavaScript Object Notation • Minimal • Textual • Subset of JavaScript Values • Strings • Numbers • Booleans • Objects • Arrays • null Array ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"] [ [0, -1, 0], [1, 0, 0], [0, 0, 1] ] Object { "name": "Jack B. Nimble", "at large": true, "grade": "A", "format": { "type": "rect", "width": 1920, "height": 1080, "interlace": false, "framerate": 24 } } Object Map { "name": "Jack B. Nimble", "at large": true, "grade": "A", "format": { "type": "rect", "width": 1920, "height": 1080, "interlace": false, "framerate": 24 } } JSON limitations • No binary data (byte strings) • Numbers are in decimal, some parsing required • Format requires copying: • Escaping for strings • Base64 for binary • No extensibility (e.g., date format?) • Interoperability issues • I-JSON further reduces functionality (RFC 7493) 12 BSON and friends • Lots of “binary JSON” proposals • Often optimized for data at rest, not protocol use (BSON ➔ MongoDB) • Most are more complex than JSON 13 Why a new binary object format? • Different design goals from current formats – stated up front in the document • Extremely small code size – for work on constrained node networks • Reasonably compact data size – but no compression or even bit-fiddling • Useful to any protocol or application that likes the design goals 14 Concise Binary Object Representation (CBOR) 15 “Sea Boar” “Sea Boar” 16 Design goals (1 of 2) 1.
    [Show full text]
  • JSON JSON (Javascript Object Notation) Ecmascript Javascript
    ECMAScript JSON ECMAScript is standardized JavaScript. The current version is the 12th edition: Péter Jeszenszky Ecma International, ECMAScript 2021 Language Specification, Standard ECMA-262, 12th ed., June 2021. https://www.ecma- international.org/publications-and-standards/standards/ecma-262/ October 8, 2021 The next version currently under development is ECMAScript 2022: ECMAScript 2022 Language Specification https://tc39.es/ecma262/ Péter Jeszenszky JSON October 8, 2021 1 / 94 Péter Jeszenszky JSON October 8, 2021 3 / 94 JSON (JavaScript Object Notation) JavaScript Lightweight, textual, and platform independent data exchange format. Used for representing structured data. The term JavaScript is used for the implementations of ECMAScript by different vendors. Can be read and written easily by humans. See also: JavaScript technologies overview Can be generated and processed easily by computer programs. https://developer.mozilla.org/en- US/docs/Web/JavaScript/JavaScript_technologies_overview Originates from the ECMAScript programming language. Website: https://www.json.org/ Péter Jeszenszky JSON October 8, 2021 2 / 94 Péter Jeszenszky JSON October 8, 2021 4 / 94 JavaScript Engines (1) Node.js (1) SpiderMonkey (written in: C/C++; license: Mozilla Public License 2.0) https://spidermonkey.dev/ A JavaScript runtime environment built on the V8 JavaScript engine The JavaScript engine of the Mozilla Project. that is designed to build scalable network applications. V8 (written in: C++; license: New BSD License) https://v8.dev/ Website: https://nodejs.org/ https://github.com/nodejs/node https://github.com/v8/v8/ License: MIT License The JavaScript engine of Chromium. Written in: C++, JavaScript JavaScriptCore (written in: C++; license: LGPLv2) https://developer.apple.com/documentation/javascriptcore https: Platform: Linux, macOS, Windows //github.com/WebKit/webkit/tree/master/Source/JavaScriptCore The JavaScript engine developed for the WebKit rendering engine.
    [Show full text]
  • Advanced JSON Handling in Go 19:40 05 Mar 2020 Jonathan Hall Devops Evangelist / Go Developer / Clean Coder / Salsa Dancer About Me
    Advanced JSON handling in Go 19:40 05 Mar 2020 Jonathan Hall DevOps Evangelist / Go Developer / Clean Coder / Salsa Dancer About me Open Source contributor; CouchDB PMC, author of Kivik Core Tech Lead for Lana Former eCommerce Dev Manager at Bugaboo Former backend developer at Teamwork.com Former backend developer at Booking.com Former tech lead at eFolder/DoubleCheck 2 Show of hands Who has... ...used JSON in a Go program? ...been frustrated by Go's strict typing when dealing with JSON? ...felt limited by Go's standard JSON handling? What have been your biggest frustrations? 3 Today's Topics Very brief intro to JSON in Go Basic use of maps and structs Handling inputs of unknown type Handling data with some unknown fields 4 A brief intro to JSON JavaScript Object Notation, defined by RFC 8259 Human-readable, textual representation of arbitrary data Limted types: null, Number, String, Boolean, Array, Object Broad applications: Config files, data interchange, simple messaging 5 Alternatives to JSON YAML, TOML, INI BSON, MessagePack, CBOR, Smile XML ProtoBuf Custom/proprietary formats Many principles discussed in this presentation apply to any of the above formats. 6 Marshaling JSON Creating JSON from a Go object is (usually) very straight forward: func main() { x := map[string]string{ "foo": "bar", } data, _ := json.Marshal(x) fmt.Println(string(data)) } Run 7 Marshaling JSON, #2 Creating JSON from a Go object is (usually) very straight forward: func main() { type person struct { Name string `json:"name"` Age int `json:"age"` Description string `json:"descr,omitempty"` secret string // Unexported fields are never (un)marshaled } x := person{ Name: "Bob", Age: 32, secret: "Shhh!", } data, _ := json.Marshal(x) fmt.Println(string(data)) } Run 8 Unmarshaling JSON Unmarshaling JSON is often a bit trickier.
    [Show full text]
  • JSON As an XML Alternative
    JSON The Fat-Free Alternative to XML { “Lecture”: 27, “Course”: “CSC375”, “Days”: ”TTh", “Instructor”: “Haidar Harmanani” } JSON as an XML Alternative • JSON is a light-weight alternative to XML for data- interchange • JSON = JavaScript Object Notation – It’s really language independent – most programming languages can easily read it and instantiate objects or some other data structure • Defined in RFC 4627 • Started gaining tracking ~2006 and now widely used • http://json.org/ has more information JSON as an XML Alternative • What is JSON? – JSON is language independent – JSON is "self-describing" and easy to understand – *JSON uses JavaScript syntax for describing data objects, but JSON is still language and platform independent. JSON parsers and JSON libraries exists for many different programming languages. • JSON -Evaluates to JavaScript Objects – The JSON text format is syntactically identical to the code for creating JavaScript objects. – Because of this similarity, instead of using a parser, a JavaScript program can use the built-in eval() function and execute JSON data to produce native JavaScript objects. Example {"firstName": "John", l This is a JSON object "lastName" : "Smith", "age" : 25, with five key-value pairs "address" : l Objects are wrapped by {"streetAdr” : "21 2nd Street", curly braces "city" : "New York", "state" : "NY", l There are no object IDs ”zip" : "10021"}, l Keys are strings "phoneNumber": l Values are numbers, [{"type" : "home", "number": "212 555-1234"}, strings, objects or {"type" : "fax", arrays "number” : "646 555-4567"}] l Aarrays are wrapped by } square brackets The BNF is simple When to use JSON? • SOAP is a protocol specification for exchanging structured information in the implementation of Web Services.
    [Show full text]
  • Open Source Used in Cisco DNA Center Release 1.3.X
    Open Source Used In Cisco DNA Center NXP 1.3.1.0 Cisco Systems, Inc. www.cisco.com Cisco has more than 200 offices worldwide. Addresses, phone numbers, and fax numbers are listed on the Cisco website at www.cisco.com/go/offices. Text Part Number: 78EE117C99-201847078 Open Source Used In Cisco DNA Center 1.3.1.0 1 This document contains licenses and notices for open source software used in this product. With respect to the free/open source software listed in this document, if you have any questions or wish to receive a copy of any source code to which you may be entitled under the applicable free/open source license(s) (such as the GNU Lesser/General Public License), please contact us at [email protected]. In your requests please include the following reference number 78EE117C99-201847078 Contents 1.1 1to2 1.0.0 1.1.1 Available under license 1.2 @amcharts/amcharts3-react 2.0.7 1.2.1 Available under license 1.3 @babel/code-frame 7.0.0 1.3.1 Available under license 1.4 @babel/highlight 7.0.0 1.4.1 Available under license 1.5 @babel/runtime 7.3.4 1.5.1 Available under license 1.6 @mapbox/geojson-types 1.0.2 1.6.1 Available under license 1.7 @mapbox/mapbox-gl-style-spec 13.3.0 1.7.1 Available under license 1.8 @mapbox/mapbox-gl-supported 1.4.0 1.8.1 Available under license 1.9 @mapbox/whoots-js 3.1.0 1.9.1 Available under license 1.10 abab 2.0.0 1.10.1 Available under license 1.11 abbrev 1.1.1 1.11.1 Available under license 1.12 abbrev 1.1.0 1.12.1 Available under license 1.13 absurd 0.3.9 1.13.1 Available under license
    [Show full text]
  • Better Than Protocol Buffers
    Better Than Protocol Buffers Grouty Jae never syntonises so pridefully or proselytise any centenarian senselessly. Rawish Ignacius whenreindustrializes eastwardly his Bentley deepening hummings awake gruesomely credulously. and Rab pragmatically. usually delights furthest or devoiced mundanely Er worden alleen cookies on windows successfully reported this variable on tag per field encoding than protocol buffers, vs protocol buffers Protocol buffers definitely seem like protocol buffers objects have to. Strong supporter of STEM education. Then i objectively agree to better than json with. There is, of course, a catch: The results can only be used as part of a new request sent to the same server. Avro is a clear loser. Add Wisdom Geek to your Homescreen! Google may forecast the Protocol Buffers performance in their future version. Matches my approach and beliefs. To keep things simple a ass is situate in hebrew new frameworks. These different protocols that protocol buffers and better this role does this technology holding is doing exactly what. Proto files which i comment if you want to better than jdk integer should check when constrained to. How can Use Instagram? The JSON must be serialized and converted into the target programming language both on the server side and client side. Get the latest posts delivered right to your inbox. Sound off how much better than protocol. This broad a wildly inaccurate statement. Protobuf protocol buffers are better than words, we developed in json on protocols to medium members are sending data access key and its content split into many languages? That project from descriptor objects that this makes use packed binary encodings, you are nice, none of defence and just an attacker to.
    [Show full text]
  • Efficient XML Interchange for Afloat Networks
    LT Bruce Hill MAKING BIG FILES SMALL AND SMALL FILES TINY 1 XML and JSON ● JavaScript Object Notation (JSON) is a common alternative to XML in web applications ● JSON is a plaintext data-interchange format based on JavaScript code ● JSON has compact binary encodings analogous to EXI: ○ CBOR ○ BSON ● Research Question: Is EXI more compact than CBOR and BSON? 2 EXI for Large XML Files ● W3C and previous NPS research measured EXI performance on XML up to 100MB ● Large data dumps can easily exceed that ● Research Question: How does EXI (but not CBOR/BSON) perform on files from 100MB - 4GB? 3 Methods Use Case Focus Configuration Focus ● Compression results ● EXI has many across multiple use configuration options cases look different from that affect results for multiple files ● Compactness within a single use case ● Processing speed ● Select a few use cases ● Memory footprint ● Fidelity and study them in-depth ● XML Schema affects EXI compression as well 4 Encodings Compared Small Files Large Files When in doubt, try every possible combination of options 5 Small-file Use Cases (B to KB) ● OpenWeatherMap ● Automated Identification ● Global Position System System (AIS) XML (GPX) 6 AIS Use Case EXI smaller than CBOR/BSON, aggregating data helps 7 AIS Use Case Well-designed XML Schema improves performance 8 Large-file Use Cases (KB to GB) ● Digital Forensics XML ● Packet Description (DFXML) Markup Language ● OpenStreetMap (PDML) 9 PDML Use Case EXI performs well on large files, aggregation benefits plateau 10 EXI and MS Office ● Microsoft Office is ubiquitous in Navy/DoD ● Since 2003, the file format has been a Zipped archive of many small XML files ● Since 2006, the file format has been an open standard ● Since 2013, MS Office 365 can save in compliant format ● Tools such as NXPowerLite target excess image resolution and metadata to shrink them ● EXI can target the remainder..
    [Show full text]
  • JSON and BSON Data Models file:///Users/Jrg/235-2021-SPRING/SLIDES/WEEK08/18Jsonandbson/18Jsonandbson.Html#1
    JSON and BSON Data Models file:///Users/jrg/235-2021-SPRING/SLIDES/WEEK08/18jsonandbson/18jsonandbson.html#1 CSCI235 Database Systems JSON and BSON Data Models Dr Janusz R. Getta School of Computing and Information Technology - University of Wollongong 1 of 11 10/8/21, 2:57 pm JSON and BSON Data Models file:///Users/jrg/235-2021-SPRING/SLIDES/WEEK08/18jsonandbson/18jsonandbson.html#1 JSON and BSON Data Models Outline JSON ? What is it ? BSON ? What is it ? TOP Created by Janusz R. Getta, CSCI235 Database Systems, Spring 2021 2/11 2 of 11 10/8/21, 2:57 pm JSON and BSON Data Models file:///Users/jrg/235-2021-SPRING/SLIDES/WEEK08/18jsonandbson/18jsonandbson.html#1 JSON ? What is it ? Java Script Object Notation (JSON) is a light–weight data interchange format It is based on a subset of the JavaScript Programming Language Standard ECMA-262 3rd Edition - December 1999 JSON is built on two structures: - A collection of name:value pairs - object - An ordered list of values - array Object is an unordered set of name:value pairs JSON objects {"first name": "James"} {"city":"Sydney", "street":"Victoria", "building number":25} {"number":"25", "isOdd ?":true, "nothing":null} Empty JSON object { } TOP Created by Janusz R. Getta, CSCI235 Database Systems, Spring 2021 3/11 3 of 11 10/8/21, 2:57 pm JSON and BSON Data Models file:///Users/jrg/235-2021-SPRING/SLIDES/WEEK08/18jsonandbson/18jsonandbson.html#1 JSON ? What is it ? Value is either a string or a number or true or false or null or an object or an array JSON object with the special characters {"single quote": "\'", "back slash":"\\", "forward slash":"\/", "line feed":"\u000A" } JSON object with a number, true, false, and nothing values {"fraction":0.25, "true":true, "false":false, "nothing": null} Nested JSON object {"full name": {"first name":"James", "initials":null, "last name":"Bond"}, "number":"007"} JSON object with an array of strings {"colours":["red", "green", "blue"]} JSON object with an array of numbers {"numbers":[10, 20, 30, 40, 50]} TOP Created by Janusz R.
    [Show full text]