Skip to main content

Some Beginner Tips for Working with JSON - From a Beginner

We are enhancing the Oracle Dev Gym to automatically execute code you type as a solution to a problem, and validate that it works. We are doing this via REST calls to LiveSQL. It's very cool and a lot of fun to put together. Hopefully it will be way more fun for you to see if you can solve our challenges.

Anyway, LiveSQL is going to pass back results via a JSON document, which means that yes, finally, I am going to start working with JSON and learning about Oracle Database JSON functionality.

Yes, I am a total novice at this. Which, I imagine, is the case for many other PL/SQL developers. So I thought I would immediately share some early lessons learned. That way maybe you will save yourself the 15 minutes I wasted sorting this out.

First, though, if you haven't done anything with JSON yet, start by looking over these:

JSON in Oracle Database
JSON Support in Oracle Database 12c Release 1 (12.1.0.2)

Plus, all the code shown below can be seen, and run, in LiveSQL.

OK. So first I created a table to hold my JSON documents:

CREATE TABLE json_data (my_doc CLOB)
/

Then I insert a row of data. JSON! (or so I thought)

BEGIN
   INSERT INTO json_data
        VALUES (q'^{
          "without_spaces" : "OK",
          "with spaces not a good idea" : "Not OK",
          "carriage returns definitely bad idea" : 
      "BEGIN 
          DBMS_OUTPUT.PUT_LINE ('Hello JSON!'); 
       END;"}^');

   COMMIT;
END;
/

Use the JSON_VALUE function to get the value for a given property name.

SELECT json_value (j.my_doc, '$.without_spaces') r
  FROM json_data j
/

OK

I can also enclose the property name inside double quotes:

SELECT json_value (j.my_doc, '$."without_spaces"') r
  FROM json_data j
/

OK

Now let's the value for a property name that contains spaces:

SELECT json_value (j.my_doc, '$.with spaces not a good idea') r
  FROM json_data j
/

ORA-40442: JSON path expression syntax error ('$.with spaces not a good idea')

Ugh. OK, so if I am going to put spaces in my names I must enclose that name within double quotes in my call to JSON_VALUE:

SELECT json_value (j.my_doc, '$."with spaces not a good idea"') r
  FROM json_data j
/

Not OK

Fine. Now let's get that PL/SQL block back from my table - notice, I remembered to include the double quotes:


SELECT NVL (json_value (j.my_doc
                      , '$."carriage returns definitely bad idea"'), 'NULL') r
  FROM json_data j
/

NULL

Nothing there! Nothing there? But there is something there. What's going on?

So now I waste time trying to figure it out - but you get to save yourself the time by reading my blog! The problem is that you cannot have carriage returns or newline characters in your JSON values. In other words, that "JSON document" I inserted isn't even valid JSON. And I didn't realize it, because I was lazy and did not tell Oracle Database that the my_doc column contains JSON.

Let's do that:

DELETE FROM json_data
/

ALTER TABLE json_data
ADD CONSTRAINT json_data_json_chk
CHECK (my_doc IS json) enable
/

And  now when I try to insert this value....kaboom!

BEGIN
   INSERT INTO json_data
        VALUES (q'^{
          "without_spaces" : "OK",
          "with spaces not a good idea" : "Not OK",
          "carriage returns definitely bad idea" : 
      "BEGIN 
          DBMS_OUTPUT.PUT_LINE ('Hello JSON!'); 
       END;"}^');

   COMMIT;
END;
/

ORA-02290: check constraint (JSON_DATA_JSON_CHK) violated ORA-06512: at line 2

OK. So I replace the newline characters with "\n", a standard replacement string to indicate a new line. In the code below you see "\\" because the first \ escapes the next one.

BEGIN
   INSERT INTO json_data
        VALUES (q'^{
          "without_spaces" : "OK",
          "with spaces not a good idea" : "Not OK",
          "carriage returns definitely bad idea" : 
      "BEGIN\\nDBMS_OUTPUT.PUT_LINE ('Hello JSON!');\\nEND;"}^');

   COMMIT;
END;
/

And now....no problems!

SELECT json_value (j.my_doc, '$."carriage returns definitely bad idea"') r
  FROM json_data j
/

BEGIN\nDBMS_OUTPUT.PUT_LINE ('Hello JSON!');\nEND;

And so to conclude:
  1. When stuffing JSON into a table's column, make sure you use the IS JSON check constraint to ensure valid JSON.
  2. Don't put spaces in your property names. Use underscores or camelCase.
  3. Keep newline characters out of your JSON documents.

Comments

  1. Hello Steven,
    I just read this post and have a comment: your original intention was to insert a PL/SQL block into the table. If you don't use the double backslashes for the line-breaks (…"BEGIN\n
    DBMS_OUTPUT.PUT_LINE ('Hello JSON!');\nEND;"…) your select will retrieve the block as it was your original intention and the value is displayed with the line-breaks.
    Kind regards, Niels Hecker

    ReplyDelete

Post a Comment

Popular posts from this blog

Get rid of mutating table trigger errors with the compound trigger

When something mutates, it is changing. Something that is changing is hard to analyze and to quantify. A mutating table error (ORA-04091) occurs when a row-level trigger tries to examine or change a table that is already undergoing change (via an INSERT, UPDATE, or DELETE statement). In particular, this error occurs when a row-level trigger attempts to read or write the table from which the trigger was fired. Fortunately, the same restriction does not apply in statement-level triggers. In this post, I demonstrate the kind of scenario that will result in an ORA-04091 errors. I then show the "traditional" solution, using a collection defined in a package. Then I demonstrate how to use the compound trigger, added in Oracle Database 11g Release1,  to solve the problem much more simply. All the code shown in this example may be found in this LiveSQL script . How to Get a Mutating Table Error I need to implement this rule on my employees table: Your new salary cannot be mo

How to Pick the Limit for BULK COLLECT

This question rolled into my In Box today: In the case of using the LIMIT clause of BULK COLLECT, how do we decide what value to use for the limit? First I give the quick answer, then I provide support for that answer Quick Answer Start with 100. That's the default (and only) setting for cursor FOR loop optimizations. It offers a sweet spot of improved performance over row-by-row and not-too-much PGA memory consumption. Test to see if that's fast enough (likely will be for many cases). If not, try higher values until you reach the performance level you need - and you are not consuming too much PGA memory.  Don't hard-code the limit value: make it a parameter to your subprogram or a constant in a package specification. Don't put anything in the collection you don't need. [from Giulio Dottorini] Remember: each session that runs this code will use that amount of memory. Background When you use BULK COLLECT, you retrieve more than row with each fetch,

Quick Guide to User-Defined Types in Oracle PL/SQL

A Twitter follower recently asked for more information on user-defined types in the PL/SQL language, and I figured the best way to answer is to offer up this blog post. PL/SQL is a strongly-typed language . Before you can work with a variable or constant, it must be declared with a type (yes, PL/SQL also supports lots of implicit conversions from one type to another, but still, everything must be declared with a type). PL/SQL offers a wide array of pre-defined data types , both in the language natively (such as VARCHAR2, PLS_INTEGER, BOOLEAN, etc.) and in a variety of supplied packages (e.g., the NUMBER_TABLE collection type in the DBMS_SQL package). Data types in PL/SQL can be scalars, such as strings and numbers, or composite (consisting of one or more scalars), such as record types, collection types and object types. You can't really declare your own "user-defined" scalars, though you can define subtypes  from those scalars, which can be very helpful from the p