Category: OCI

  • Add Primary and Foreign Keys to your Oracle Autonomous Database

    Add Primary and Foreign Keys to your Oracle Autonomous Database

    I’m not a Database Administrator, but I feel as though I may be slowly evolving into one…

    In a previous post, I left myself the task of correcting the html on a proposed Python/Flask/ORDS/Autonomous Database application. My then next step was to add a search bar (which I did):

    Search bar added to application for python, flask, ords, oracle autonomous database application. Chris Hoina, Oracle Senior Product Manager.
    Search bar added to the html for searching my Autonomous Database.

    Although this was a small step forward it led to some serious questions. While having a search feature like this is good in theory, in practice it is totally unusable.

    The Problem

    If a user wants to search for a specific restaurant, they’d need to know a lot of information beforehand. At a minimum, the name of their target restaurant. But even that isn’t enough. Look at when I query for a single restaurant (randomly chosen – I’m not sponsored by Wendy’s btw):

    SELECT FROM LIKE SQL statement showing a single restaurant name. Chris Hoina, ORDS, Oracle Autonomous Database
    SQL statement and the output (a single restaurant in this case).

    Some of these restaurants come back with additional store numbers (probably a reference to either a corporate- or franchise-owned property). So a search like this simply will not do.

    That’s problem number one. The second problem is that in the original datasets, while HSISID and Permit ID (read about them here) are unique in the Restaurants table. That isn’t the case with the Violations and Inspections tables. There are a TON of entries for each restaurant in these tables, and the HSISID and Permit IDs are used repeatedly for subsequent inspections. Just take a look at this example (they’re all like that though!):

    Viewing the HSISID in my table; unique identifier complications, Chris Hoina, ORDS, Oracle Autonomous Database
    Using the HSISID over and over again make it challenging to gather necessary information across all tables.

    A Closer look

    Above, is the Violations table, but the Inspection table looks similar. From what I observer, each time a violation or inspection is recorded that same HSISID is used (Permit IDs too). But in these two tables an Entry ID is used as the unique identifier. I know the image is greyed out, but if you look closely you can see the “Object ID” in that screenshot.

    But these Object IDs don’t mean anything outside of this table. And it underscores the point that my original approach to searching (i.e search bar) using a single identifier won’t work. Across the three tables these restaurants are uniquely identified in different ways.

    At a minimum, these tables should be linked so that when an HSISID is searched for in the Restaurant table, it gathers all associated data from the Violations and Inspections table too. Meaning, if I search for a specific “Wendy’s” only that target restaurant comes back along with all historical inspection and inspection violation information as well.

    Now that we understand the problem, I’ll attempt a solution. For my next feat, I’ll relate the three tables to one another in a logical way. Continue on dear reader…


    Navigating

    Navigate to your Autonomous Database, then Database Actions. Once there, look under the “Development” section, and choose “SQL”.

    Database Actions Development SQL Worksheet Oracle Autonomous Database, Chris Hoina, Senior Product Manager, Database Tools, ORDS
    NOTE: I'm sure there are other ways to accomplish this, but this is what worked for me. 

    Once in that SQL Worksheet, look at the the left side of your browser, you’ll see the Navigator tab. Of the two drop-down lists, look at the second one. That is the “Object” selector; for my purposes I made sure that Tables was selected.

    Navigator tab in Oracle Database Actions, Chris Hoina, Senior Product Manager, Database Tools, OCI, Autonomous Database
    Navigator tab in Oracle Database Actions in my Autonomous Database Always Free OCI account.

    I have the three tables; two of which (Inspections and Violations) need Foreign Keys while the third table (Restaurants) will need a Primary Key.

    My three tables in Oracle Database Actions, Chris Hoina, Senior Product Manager, Database Tools, OCI, Autonomous Database
    My three tables in Oracle Database Actions: Inspections, Restaurants, Violations
    TL;DR - The Restaurant table is like my Parent table, whereas the other two tables are like children (or dependents). Establishing these Primary and Foreign keys is a way for me to easily establish interdependence/relation among these three tables. 

    Establishing a Primary Key

    I’ll use the Restaurant table as an example. Here is the step-by-step…

    Editing my table in Oracle Database Actions, Chris Hoina, Senior Product Manager, Database Tools, OCI, Autonomous Database

    Right-click on the table (Restaurants), then select “Edit”.

    Table Properties my table in Oracle Database Actions, Chris Hoina, Senior Product Manager, Database Tools, OCI, Autonomous Database

    If a Primary Key has already been established, then you’ll see a Column (which is actually displayed as a row in this Table Properties table) that already has a check in the “PK” column.

    If there isn’t one, continue by clicking the Primary Key option (see the left-most red arrow).

    Primary Keys section in Database Actions SQL Worksheet Oracle Autonomous Database, Chris Hoina, Senior Product Manager, Database Tools, ORDS

    Once in the Primary key option, you’ll see the following boxes with checks:

    • Enabled
    • Initially Immediate,
    • Validate
    Choosing HSISID as the Primary Key in Database Actions SQL Worksheet Oracle Autonomous Database, Chris Hoina, Senior Product Manager, Database Tools, ORDS

    I’m using the HSISID (found in the “Available Columns” list) as my Primary Key. Once I select that, the “Add Selected Columns” arrow will illuminate (from white to gray). Click it once to move your selection over to the right in the “Selected Columns” list.

    Once your column has been moved, you can click “Apply”.

    Output from establishing the Primary Key in Database Actions SQL Worksheet Oracle Autonomous Database, Chris Hoina, Senior Product Manager, Database Tools, ORDS

    You’ll see this “Output” screen appear. Here you can see that my table was successfully altered. If there are errors, it’ll let you know, and there will be A LOT of red (trust me, I saw tons of red prior to writing this post).

    The DDL from a table in Database Actions SQL Worksheet Oracle Autonomous Database, Chris Hoina, Senior Product Manager, Database Tools, ORDS

    Bonus points, you can always find the Data Definition Language (DDL) in the DDL option (read up on this and the other types of SQL statements here).

    As I see it, it looks like everything since the inception of this table has been recorded. I would imagine you could take this and build some sort of automation/orchestration script with it (along with the DDL from the other tables too).

    Sample Code

    Table as a Primary Key

    CREATE TABLE ADMIN.RESTAURANTS 
        ( 
         OBJECTID           NUMBER , 
         HSISID             NUMBER , 
         NAME               VARCHAR2 (4000) , 
         ADDRESS1           VARCHAR2 (4000) , 
         ADDRESS2           VARCHAR2 (4000) , 
         CITY               VARCHAR2 (4000) , 
         STATE              VARCHAR2 (4000) , 
         POSTALCODE         VARCHAR2 (4000) , 
         PHONENUMBER        VARCHAR2 (4000) , 
         RESTAURANTOPENDATE DATE , 
         FACILITYTYPE       VARCHAR2 (4000) , 
         PERMITID           NUMBER , 
         X                  NUMBER , 
         Y                  NUMBER , 
         GEOCODESTATUS      VARCHAR2 (4000) 
        ) 
        TABLESPACE DATA 
        LOGGING 
    ;
    
    
    CREATE UNIQUE INDEX ADMIN.RESTAURANTS_PK ON ADMIN.RESTAURANTS 
        ( 
         HSISID ASC 
        ) 
        TABLESPACE DATA 
        LOGGING 
    ;
    
    ALTER TABLE ADMIN.RESTAURANTS 
        ADD CONSTRAINT RESTAURANTS_PK PRIMARY KEY ( HSISID ) 
        USING INDEX ADMIN.RESTAURANTS_PK ;

    That is literally all did to set this up. Very straightforward, next I’ll walk through how to set up Foreign keys. Then I’ll show you what it looks like in the Data Modeler so you can visually see the newly-established relationships of the tables.


    Establishing a Foreign Key

    We’re still in the SQL worksheet (found in Database Actions). Both Inspections and Violations tables need a Foreign key; I’ll demonstrate with Inspections.

    Foreign Key in Database Actions SQL Worksheet Oracle Autonomous Database, Chris Hoina, Senior Product Manager, Database Tools, ORDS

    Right-click on the table and select “Edit”, just like I did when establishing a Primary Key. Next, navigate to the “Foreign Keys” option in the Table Properties.

    Adding a Foreign Key in Database Actions SQL Worksheet Oracle Autonomous Database, Chris Hoina, Senior Product Manager, Database Tools, ORDS

    It’ll be empty, but you’ll want to click the
    “+” key (see the arrow). You’ll see “NEW_FK_1” appear under the Foreign Key table. If you click on that you can change the name to whatever your heart desires.

    I then changed the Foreign Key name to something that I could remember (and something that would make sense at a later date); “Inspections_FK”. I then selected “HSISID” as the Local Column.

    And automatically, the schema recognizes the Primary Key I previously established in the Restaurants table. I didn’t do that, that was all done for me automatically! Very cool.

    Output of the Foreign Key name change in Database Actions SQL Worksheet Oracle Autonomous Database, Chris Hoina, Senior Product Manager, Database Tools, ORDS

    After I click “Apply” you’ll see the output from this change. I can then return to the Foreign Keys option and voilà, the Foreign Key name has been changed. I’ll proceed to do the same to my “Violations” table as well.

    Sample Code

    Table as a Foreign Key

    CREATE TABLE ADMIN.INSPECTIONS 
        ( 
         OBJECTID    NUMBER , 
         HSISID      NUMBER , 
         SCORE       NUMBER , 
         DATE_       DATE , 
         DESCRIPTION VARCHAR2 (4000) , 
         TYPE        VARCHAR2 (4000) , 
         INSPECTOR   VARCHAR2 (4000) , 
         PERMITID    NUMBER 
        ) 
        TABLESPACE DATA 
        LOGGING 
    ;
    
    ALTER TABLE ADMIN.INSPECTIONS 
        ADD CONSTRAINT INSPECTIONS_FK FOREIGN KEY 
        ( 
         HSISID
        ) 
        REFERENCES ADMIN.RESTAURANTS ( HSISID ) 
        ON DELETE CASCADE 
        NOT DEFERRABLE 
    ;

    Data Modeler Primer

    This isn’t a “How-to” on the Data Modeler (Documentation here though), but rather just me taking a minute to share how you can visually see the relationships between tables. It definitely helped me better understand why I needed to establish Primary and Foreign Keys.

    Andiamo!

    Data Modeler in Database Actions in Oracle Autonomous Database, Chris Hoina, Senior Product Manager, Database Tools, ORDS

    From the Database Actions Launchpad, select “Data Modeler”.

    Navigator Tab in Data Modeler in Database Actions in Oracle Autonomous Database, Chris Hoina, Senior Product Manager, Database Tools, ORDS

    Once there, you’ll see two drop-down menus. You’ll see your current Schema (Admin for me, in this case). In the second drop-down menu, you’ll see a list of available “Objects”. I’ll want to make sure that I have “Tables” selected.

    Adding Objects to the Diagram Editor in Data Modeler in Database Actions in Oracle Autonomous Database, Chris Hoina, Senior Product Manager, Database Tools, ORDS

    You can drag these over one at a time, or select them all and drag all at once. They’ll appear in the Diagram Editor, with the relationships already included (since I already set up the Primary and Foreign Keys).

    New Diagram of tables in the Data Modeler Diagram Editor in Database Actions in Oracle Autonomous Database, Chris Hoina, Senior Product Manager, Database Tools, ORDS

    Expand these diagrams and you’ll reveal additional information. In this image, I’ve expanded the Inspections table to reveal Foreign Key details. I’ll do the same by expanding the bottom of the Violations table to reveal its Foreign Key. That little red arrow signifies that there is additional information hidden.

    Okay, but what is this?

    What we are looking at is a visual representation of the relationships between these tables. Everything is “linked” through the HSISID. My interpretation of this is that everything begins with the Restaurant table, and then the other two tables act as subordinates.

    For a single Restaurant (which has a unique HSISID) there are many entries in both Inspections and Violations that use the HSISID repeatedly. In those cases, that HSISID is no longer unique. It is still important, necessary information.

    And now that everything is linked, I’ll want to create a single query (SQL presumably) that when executed will return all relevant information from a single entry in the Restaurant table with all associated (HSISID) entries from the Inspections and Violations table, nested underneath it.

    Clear as mud? Good. Hope this helps more than it hurts.

    Now what

    Next I’ll need to come up with something (in SQL perhaps) that I believe I’ll use in tandem with ORDS. From there I’ll work on building the html portion of this python + flask application so that the search is more intuitive (to the user) and elegant (for the Autonomous Database). Believe it or not, but it took about a week to wrap my head around all this key business. Needless to say, I’m slightly behind schedule. But expect more updates as I progress.

    Hope you learned something.

    Find me

    HMU on:

  • Project Overview: python – flask – ORDS – Autonomous Database

    Project Overview: python – flask – ORDS – Autonomous Database

    Update

    For the past week and a half I’ve been immersed in learning how python and flask interact with each other so a developer can create a quick/crude web application. I’ve also spent time becoming more familiar with virtual environments (as they pertain to python + flask), jinja, and WTForms (I’m sure I’m forgetting other stuff too). But if you are like me (circa two weeks ago), then most of what I just wrote means nothing. But that’s okay, you have to start somewhere.

    I’m trying to learn all I can because I want to share my ideas (and code) with the Oracle community in the hopes that it will lead to more creative and innovative ways to connect with our Autonomous Databases.

    If you recall, as of this writing, I currently have my Autonomous Database (ADB) set up; and my three tables are REST enabled (with the help of ORDS). I also have a newly created “appdev” user (for accessing the database remotely).

    And what I’m attempting to do is develop a very basic web/mobile-friendly application in python. An application that will transform the JSON (provided via ORDS) coming from the ADB, into a readable and helpful tool.

    Which prompts the first question: how do I intend to do this?

    I think the best way to tell the story is by starting at the end, briefly, then going back to the beginning, and then periodically returning to the end, maybe giving different characters’ perspectives throughout. Just to give it a bit of dynamism, otherwise, it’s just sort of a linear story.

    David Ershon (as portrayed by the legendary Steve Coogan in the critically acclaimed 2010 film The Other Guys

    First off, its ridiculously easy to REST enable tables in your ADB. Simple mouse clicks really, take a look:

    https://twitter.com/chrishoina/status/1499829222315118596

    Now that I’ve REST enabled my tables, I can take the provided URL (see below in the image) and paste it in a separate browser window. Here you see the default is that the first 25 entries in the target table are returned.

    JSON output from my Oracle Autonomous Database, courtesy of ORDS.

    Of course, with some manipulation I can do much more than what is seen here. But the point is that everything works, thanks to ORDS (huge time saver). Although, we still need to clean up the presentation (or what a typical user might expect).

    The actual application

    So what I’d like to do is take this…word salad, and clean it up a bit; make it more presentable. Up until now I haven’t stumbled across anything that takes our JSON (via ORDS) and presents it in such a way using python + flask. I think it would be really neat, and a good chance for me to contribute something more than just funny memes and GIFs.

    If you recall, I have three datasets:

    1. Wake County Restaurants
    2. Restaurant Health Code Inspections
    3. Restaurant Inspection Violations

    All of which share the same primary key (a restaurant ID). So I thought I would produce something that would use all three of these tables in some combination.

    SHOUT OUT: Thanks to Wake County, NC for providing people with these openly-available datasets.

    The direction I’m headed is to develop a Minimum Viable Product (MVP), share the code via GitHub, then move onto the next ORDS-inspired project! After spending a few days researching and learning, I’ve cobbled together what I think might work:

    A simple mock-up of what this python, flask, autonomous database app might look like.
    A simple mock-up of what this python, flask, autonomous database + ORDS app might look like.

    This needs explanation. Let me discuss what is going on here.

    1. A user would begin on the landing page (name yet to be determined). This page of course is displayed in html.
    2. Next a user would enter in a restaurant of interest (I’ll have to begin with Wake County, NC as that is all I have access to at the moment). From there the python application would use ORDS to request information from my autonomous database.
    3. Skipping several steps for brevity, eventually this information would then be transmitted back to the user (in html).
    NOTE: I intend to follow-up with subsequent posts detailing my development progress. So this should become less opaque as we near the finish line! 

    More explanation

    Right, so what are flask, jinja, and WTForms?

    • As I understand it, Flask is a web framework that allows python developers to more easily create web applications.
    • Jinja. Apparently writing html is annoying, so jinja is an “engine” that allows developers to write in python-like code and have that code “transformed” into html. Seems like it makes it that much easier to stay in your native language (python in this case).
    • WTForms is used for form “input handling and validation”. My interpretation of this is that python developers aren’t expected to know how to communicate with databases. Much like they wouldn’t be expected to be fluent in html. So it is a way of extended python to handle requests to the ADB.

    Learning resources

    No single person is an island. Having said that, what follows (in no specific order) are resources that have helped me get to this level of understanding/comprehension. Maybe they’ll help you too.

    I’m more of a visual and practical learner, so I’ve primarily been working through tutorials on YouTube and LinkedIn Learning. I found a course on LinkedIn Learning; one that I actually did.

    Meanwhile on YouTube, I did a lot of pausing/reviewing/rewinding so I could figure out how everything works together. Luckily, python and flask seem to be very formulaic; not too dissimilar to COBOL.

    LinkedIn Learning

    Full Stack Web Development with Flask (LinkedIn Learning)

    Note: I did sections 1-4. When I got to section 5, I passively followed along for about ¾ of the section, but then reached diminishing returns. I skipped section 6; twas irrelevant.  

    YouTube

    The two channels I found helpful:

    • Codemy.com (channel) – you’ll want to use the keywords “flask Fridays”; they go as far back as 2021 and are still on-going
    • Corey Schafer (playlist) – a great start-to-finish series for building a flask/python-based web application (although not Autonomous Database + ORDS specific)

    Mac set-up

    Bookmark this guide if you want to set up your Mac for anything development-related. In my case the following sections were extremely important for this project:

    • xCode (for some reason doesn’t come preinstalled on Mac)
    • Homebrew
    • Visual Studio Code
    • Python, along with:
      • Pip
      • Virtualenv (where I learned more about virtual environments)

    Up next

    Next up, I’ll be taking what I’ve learned so far and applying it to this project. Since a user wouldn’t log in, update, or modify anything in this application, the complexity should be low.

    That isn’t to say it won’t have its challenges. But in a couple weeks I hope to have the front end connected (via ORDS) to the ADB. I’ve got a good start on what the landing page might look like. And of course once it is all polished up and properly commented, I’ll be sure to share the code.

    Screen shot of the landing page for this python, flask, ORDS, Oracle Autonomous Database application
    Screen shot of what the landing page currently looks like; running locally in a virtual environment (venv). Next up is to add a search bar and then connect to my Autonomous Database via ORDS.

    The dig continues

    Time to hit the books.

    If you want to learn more about ORDS check out these resources.

    And as always, you can find me here:

  • Create a user in Oracle Autonomous Database [for Dummies]

    Create a user in Oracle Autonomous Database [for Dummies]

    An OCI user does not ≠ ADB user

    Creating an additional user in your Oracle Cloud Infrastructure (OCI) is not the same thing as creating an additional user in your Autonomous Database (ADB). I spent about two days (on and off) last week, wrapping my head around this. Maybe you knew this…I did not.

    Chris Hoina – 2022

    If however, you want to create an additional OCI user; one that would be able to access various resources in OCI, then please bookmark this page. This is all you need to get started.

    However, you may not even need to create this additional user (as was the case with me). While I followed the steps in that documentation (very simple/straightforward actually), it wasn’t till after I finished, did I realize that doing it was completely unnecessary. What I was really trying to do was create a new database user, not an OCI user. The steps are different, simpler.

    Federations

    Another area that I got really hung up was with “Federations”. This was a relatively new concept for me. And I’m not sure if I should even do a deep dive on how Federations work. However, let it be known, if I receive even one (legitimate) comment on this subject, I will put together a treatise on Federations in OCI.

    It took me about a day and a half to educate myself on how Federations and Identity Providers work in OCI. So, if you are reading this, and you think you’d benefit from a standalone article, then let me know. Otherwise, this page and this page are both very helpful for learning more about Federations in OCI.

    Are you me?

    If so, then you are acting as an administrator in your Always Free OCI account, as well as the database administrator. Being both is confusing for me, and maybe it is for you too. Since I don’t consider myself a traditional user (I’m blurring the lines when it comes to the different roles), I’m tasked with managing my OCI tenancy and also setting up my development environment. All this so I can begin to work on some applications/proofs of concepts (POCs) for interacting with my Autonomous Database via ORDS (Oracle REST Database Services aka our REST APIs).

    Don’t be like me and allow yourself to get too weighed down with all the technical jargon thrown your way. Naturally, our docs read like they are geared toward the System or Database Administrator. And this makes sense; remember when you are in your tenancy you’re the de-facto admin for everything. At a larger organization/enterprise a developer would probably never do any of this setup. You’d just sign in to the database directly or connect via a command line.

    Workflow for the “Every Person”

    But for me (with my limited experience), the workflow looks something like this:

    Start here

    Sign-up for an Oracle Cloud Account. You’ll be provided a Cloud Account Name* and credentials.

    *You’ll also hear this account being referred to as your Tenancy name (you can modify the name later if you want).

    When you sign in, you can quickly tell if you are the administrator by seeing if the "Service User Console" option is available. This is the administrator for the Oracle Cloud Infrastructure. Your tenancy.

    Next, create an Autonomous Database and create the “ADMIN” credentials* for said database. You can see how to do that in Lab 1 of this workshop

    REMINDER: This administrator is different that the OCI Tenancy administrator.

    Add a new user by:

    Navigating to your Autonomous Database under "Oracle Database".  It might be in your recently viewed.

    Navigating to your Autonomous Database under “Oracle Database”. It might be in your recently viewed.

    Once you've created your Autonomous Database, navigate to Database Actions. This is where you need to go to create a new user.

    After you click the database, you’ll see this screen. Click “Database Actions”. You’ll link out to the Database Actions dashboard.

    Navigate to the Administration tile, and click it. It will take you to a dashboard of all current users, along with an option to create a new user.

    Select the Database Users option in the Administration section.

    Create a new user. Afterward, you'll be provided an URL that allows a user to directly log into the Oracle Autonomous Database Actions Launchpad.


    Select the “Create User” option.

    Toggling the Web Access switch will automatically grant the user the CONNECT and RESOURCE roles.

    At a minimum, you’ll want to enable “Web Access” for this user. This will automatically grant two roles for the user:

    1. CONNECT
    2. RESOURCE

    Both are needed for the developer though.

    Here you can see all the available roles. The CONNECT and RESOURCE roles are already checked because you will have selected "Web Access" in the previous tab.

    If you want to take a look at the different roles available, click this tab. Scrolling through, you can see the CONNECT and RESOURCE roles are checked.

    HINT: You can always go back and edit the roles if more roles need to be granted. Both are needed for the developer though.

    Finish (kind of)

    You can see the URLs in this image.  This, along with the login credentials are what should be provided to the user.  They can log in to the Database Actions console directly.

    Once complete, you’ll see a URL in that user’s newly-created tile. This URL will link you out to a login page, for accessing the Database Actions console. Since you are the only user, you’ll just want to document the URL. Otherwise, as the admin, I’m assuming you’d share this with the respective recipient.

    Next Up

    From here on out, I’ll do all my development work with this account (I called mine “appdev”), to mimic what a typical user might encounter in a practical setting.

    Right now, I’ m wrapping up a python + flask + database course on LinkedIn Learning. So far, its been pretty informative. If you are interested, you can take a look as well (to see the direction I’m headed). My goal will be to use the templates in this course as a resource for connecting to my database, but with ORDS.

    I hope to have something small in the next week or so. And I’ll be sharing here, and on my GitHub as well. So stay tuned.

    Helpful resources

    What I did here was very simplified, a distillation for creating a new user in your Autonomous Database. But I’ll include some of the resources that helped get me to this level of understanding:

    Find me

    And that’s it for now. But if you want to follow along then check me out at these places…

  • Table Prep: Data loads and time zones

    Table Prep: Data loads and time zones

    Next episode

    My Autonomous Database in Oracle Cloud Infrastructure

    With my Autonomous Database up and running,I needed to find some data to upload. After some quiet reflection, I decided upon three datasets that should be plenty fun.

    A bit of context; I currently live in Wake County, North Carolina. And it turns out that we’ve been very progressive with providing open, accessible data to our citizens. I really wanted to do something with food, so I was surprised when I found the following three datasets (among the nearly 300 available):

    1. Restaurants in Wake County
    2. Restaurant Food Inspections/Grades
    3. Restaurant Food Inspection Violation History
    Restaurants in Wake County, North Carolina. Wake County is where I, Chris Hoina, live.

    Always read the docs

    Upon reading the documentation, I discovered that these datasets could be all connected through their HSISID* Permit ID fields. Which should come in handy later as it could make for some very interesting (if not amusing) revelations.

    *I’m not sure of the acronym, but the documentation defines the HSISID as a, “State code identifying the restaurant (also the primary key to identify the restaurant).”

    To the data loading

    I’m sticking with the Oracle Database Actions* web-based interface for now.

    *Oracle Database Actions was previously known as Oracle SQL Developer Web.
    In the Database Actions Launchpad, there are several actions for users. This includes development, data-loading, monitoring, and administration.
    The Database Actions Launchpad offers several actions for users, including development, data loading, monitoring, and administration.

    And from what I learned in the Autonomous Database workshop, there are two ways to load data into your database (there may be other methods; mea culpa if so):

    1. SQL worksheet (found in the Development section, of your launchpad)
    2. Data Load Tool (found in the Data Tools section)

    And I opted for the SQL worksheet method since I need to practice and learn this method regardless.

    Obstacles

    After choosing my method of data loading, I encountered some obstacles. With no regard for best practices, I proceeded to load all three datasets into my Autonomous Database only to discover two glaring issues.

    First

    Unfortunately, in my restaurant “violations” table, I encountered two rows that failed to load.

    ORA-12899 error in Oracle Autonomous Database on Oracle Cloud Infrastructure.
    ORA-12899 error in Oracle Autonomous Database on Oracle Cloud Infrastructure.

    These values were loaded as a VARCHAR2 datatype, which, by default, allows for a maximum byte size of 4000 bytes. Since these rows exceeded 4000 bytes (in that specific column) they failed. Fortunately, it was easy to increase the bytes to 10,000.

    While you can increase it to 32,767 bytes, that is overboard. VARCHAR2 data types can have their max string sizes set to ‘STANDARD’ or ‘EXTENDED’ (i.e 4000 bytes vs 32,767 bytes). I’m assuming the Autonomous Database is set to EXTENDED by default, since I was able to increase this column, and re-upload with zero failed rows. You can read up on VARCHAR2 data types here.

    Second

    The second obstacle I ran into, took me about a day (on and off) to figure out. The dates in all three of these tables were constructed like this:

    Timestamps in Oracle Autonomous Database.
    Adjusting for the TIMESTAMPS in the Oracle Autonomous Database.

    At first glance, I thought I was looking at a time zone offset. Dates were either 04:00:00+00 hrs or 05:00:00+00 hrs; possibly due to daylight savings time. This seemed like a reasonable assumption since the early-November — mid-March dates were an hour later than the mid-March — early-November dates (i.e., UTC-4hrs in Winter, UTC-5hrs all else).

    My first thought was to modify the affected columns with something like this parameter:

    TIMESTAMP [(fractional_seconds_precision)] WITH TIME ZONE

    or with…

    TIMESTAMP '1997-01-31 09:26:56.66 +02:00'

    But, I’d never seen this date/time stamp before (the ‘esriFieldTypeDate’), so I had to investigate before I did anything (also, I’ve no idea how to update a column with a parameter like this, so it would have added additional time).

    Turns out this data originates from ArcGIS Online. This field data type maps directly to Oracle’s ‘TIMESTAMP’ data type. Seen here in the documentation:

    ArcGIS datatype mapping to Oracle Database.
    In the ArcGIS documentation, the ‘esriFieldTypeDate’ appears to map to Oracle’s ‘TIMESTAMP’ datatype.

    I later tinkered with an API Explorer on the Wake County datasets site and reviewed a sample JSON response for this data set. The response also confirmed the field type:

    Wake County has an API Explorer on their datasets site, which you can sample query to review the JSON that is returned.
    Wake County has an API Explorer on its datasets site, where you can sample a query to review the JSON that is returned.

    It’s funny because, after all this hunting, it looks like I won’t be able to include time zones anyways. It’s somewhat inconsequential as I’m only interested in Wake County, but for some that could be unnerving.

    I wish I could say that I came up with a cool Python script to automate the cleaning of these columns (I would have had to do this for all three of my .CSV files), but I did not. It would have taken me an afternoon or longer to work through this since I haven’t toyed with .CSV Reader (in the Python standard library), Pandas, or NumPy in quite some time. In the end, (and it pains me to say this, embarrassingly, really), I used the ‘Find + Replace’ feature in Numbers to remove the time/time zone portion of the dates.

    I’m pathetic, I know. But the idea of creating a dedicated Python script does seem like a fun weekend project. Who knows, maybe I’ll post to GitHub. Regardless, my Autonomous Database is clean and primed for ORDS.

    In closing

    In closing

    My advice is as such:

    Always inspect your data before you do anything major, always make sure you understand the inputs and the resultant outputs of the data loading process, and always refer to the documentation FIRST so you can understand how data is being recorded, coded, displayed, etc..

    Chris Hoina, 2022

    Oh, and it wouldn’t hurt to think about how you might use this data in the future. I’m guessing that could help you avoid a lot of rework (i.e. technical debt).

    Take me as an example. Since I’m focused on ORDS and REST enabling my database, I may want to consider things like:

    • What am I going to expose (via REST APIs)? or
    • What fields might the presentation layer of my application include?

    In my case, a lot of this data will lay dormant, as I might choose to focus on only a few key fields. Of course, anything I create will be simple and basic. But that might not be the case for you.

    Koala RESTing, Photo by Jordan Whitt on Unsplash

    I’m off to REST…enable this database now, but in the meantime, if you want to learn more about ORDS, check out:

    Find me

    And as always, catch me on:

  • An Oracle Autonomous Database workshop: here is what I learnt

    An Oracle Autonomous Database workshop: here is what I learnt

    Pop Quiznos

    Recently, I traveled to Colorado. While flying, I finished up an Autonomous Database (ADB) workshop. What I’m saying is…I was in the clouds, on the cloud.

    In my new new role, much of my work will be focused on Oracle’s REST Data Services (ORDS). But I’m starting out with the ADB.

    After completing the workshop, I thought I’d share initial impressions and lessons learned. But first…a crash course on our Cloud Free Tier accounts and Always Free cloud services. Both are relevant for this workshop.  

    Oracle Cloud Free Tier

    When you sign up for an Oracle Cloud Infrastructure (OCI) account, you are automatically entitled to Always Free services. You’re also given a 30-day/$300 USD worth of free credits trial to use on all eligible OCI services (30 days or $300, whichever comes first). But the Always Free services are available for an unlimited period. This workshop uses Always Free services (lucky you).

    Always Free

    Errthang you get with Always Free…we are most concerned with the database options though.

    On Databases

    Credits can be used on many items (see above). And that includes various databases. In the workshop you get to provision an Autonomous Data Warehouse (we’re still Always Free).  

    The Autonomous Database (ADB)

    Overview

    The ADB calls OCI home. It’s a fully managed, pre-configured database environment. Four workload types are available:

    • Autonomous Transaction Processing
    • Autonomous Data Warehouse
    • Autonomous JSON Database
    • Oracle APEX Application Development
    NOTE: Always Free entitles you to two of the above databases; each with 1 OCPU* and 20 GB storage. There is also an option to choose a noSQL Database with 133 million reads/writes per month, 25 GB storage per table (up to 3 tables).
    ALSO: An “OCPU” is an Oracle Compute Unit. 1 OCPU on the x86 (AMD/Intel) architecture is equivalent to 2 virtual processor cores (vCPUs). Whereas on the ARM architecture, the ratio is 1:1 (i.e., 1 OCPU = 1 vCPU).

    Automation

    Zero hardware configuration/management or software installation/configuration is required! Once your database is created, nearly everything is automated:  

    • Backups
    • Patching
    • Upgrading
    • Performance tuning

    You’re a Database Administrator (DBA) and you didn’t even know it!

    Scaling

    The ADB shines here. CPU and storage can be scaled automatically. Auto-scaling can automatically add more CPU cores to the base number of cores during periods of high demand, and then automatically reduce the number of cores back to the base number as demand decreases (auto-scaling also allows up to three times the current base number of CPU cores at any time).

    DISCLAIMER: Auto-scaling isn’t an Always Free cloud service, but it’s still cool and worth talking about. However, should you choose to upgrade in the future, it’s very easy to do:

    To the Workshop!

    The FREE workshop consists of five labs (and an optional sixth):

    • Lab 1: Provision an Autonomous Database
    • Lab 2: Work with Free Sample Data Sets
    • Lab 3: Load Data
    • Lab 4: Query External Data
    • Lab 5: Visualize Your Data

    Once you’ve requested an Oracle Cloud account (everything can be done with the Free Tier option), you’ll then create an Autonomous Database. The instructions for requesting your account are simple and can be found here (but also on the workshop’s landing page).

    Lab 1

    Just two steps here, simple. Everything is done through the Oracle Cloud dashboard. My two takeaways:

    1. WRITE DOWN all your login/credential information! I hadn’t considered that as an Oracle employee I’d have more than one login (it can be confusing). Not to mention later, you’ll be creating an ADMIN password for the actual database (separate from your tenancy credentials).
    2. Initial Database configuration. I really appreciated that when you first configure your Autonomous Database, you are automatically provided 1 CPU and 20 GB of storage. But should you require more CPU or storage, everything can be adjusted with simple drop-down menus. Is nice that a user (like a developer or non-System/Database Administrator role) can provision their own free playground in a matter of minutes.

    Lab 2

    Oracle Database Web Browser.  My Autonomous Database.

    Lab 2 reinforces how simple this workshop is. At this point, I’m still in the web browser. But of course, you could use the desktop option, Oracle SQL Developer.

    1. Things seemed fast. And that is saying something, because for part of this workshop (Lab 3 actually), I was in the air flying from Denver, Colorado to Raleigh, North Carolina using the airline wi-fi and objects were actually loading into their OCI buckets (I write about this later).
    2. Second takeaway was caching. When possible, the autonomous database caches query results. Meaning, for subsequent queries, results are just…there. That is a big deal to me, because in my previous role I was a Product Manager for an application performance tool. And there are a couple of things that just absolutely kill an application’s response time and/or throughput:
    • CPU intensive tasks (often repetitive ones)
    • I/O processes

    TL;DR – we like fast. Fast is good 🙂

    Lab 3

    Floppy discs to represent data in the Oracle Cloud Autonomous Database

    You’re creating a “Bucket” in the OCI and then loading Objects (approximately 45 floppy discs worth of .CSV and .DAT files) into that Bucket. Again, this is all point and click, and done in-browser. There is a wizard that guides you through everything. For someone who isn’t familiar with System or Database Administration, this was helpful and it made approaching “infrastructure” so much more accessible and seemingly less daunting.

    I should remind that this might not be your typical workflow. You might not create a Bucket and then load Objects every time. But you will still need a URI, authorization token, and credentials to load this data into the specified database.

    This lab was still a good exercise even for the non-Systems or Database Administrator. Maybe you’re a Developer or Business Intelligence Analyst. I don’t suspect many will perform all these tasks. But its important to understand how teams/roles/individual members are connected (from end-to-end).

    One final thing I appreciated about this lab, was that there were two options for loading data into respective locations:

    1. the DATA LOAD tools option from within the Database Actions dashboard, or
    2. the PL/SQL package (DBMS_CLOUD)

    Lab 4

    Up until this point I felt like I was an active participant. But here I felt like I was cheating. he code snippets you are provided allow you to create an external table directly from your cloud object store (excerpt of the code; click the image to go to our GitHub). 

    /* Specify the URL that you copied from your files in OCI Object Storage in the define base_URL line below*/
    
    set define on
    /* Specify the URL that you copied from your files in OCI Object Storage in the define base_URL line below*/
     
    set define on
    define &file_uri_base = '<bucket URI>'
     
    begin
     dbms_cloud.create_external_table(
        table_name =>'CHANNELS_EXT',
        credential_name =>'OBJ_STORE_CRED',
        file_uri_list =>'&file_uri_base/chan_v3.dat',
        format => json_object('ignoremissingcolumns' value 'true', 'removequotes' value 'true'),
        column_list => 'CHANNEL_ID NUMBER,
            CHANNEL_DESC VARCHAR2(20),
            CHANNEL_CLASS VARCHAR2(20),
            CHANNEL_CLASS_ID NUMBER,
            CHANNEL_TOTAL VARCHAR2(13),
            CHANNEL_TOTAL_ID NUMBER'
     );
     
     dbms_cloud.create_external_table(
        table_name =>'COUNTRIES_EXT',
        credential_name =>'OBJ_STORE_CRED',
        file_uri_list =>'&file_uri_base/coun_v3.dat',
        format => json_object('ignoremissingcolumns' value 'true', 'removequotes' value 'true'),
        column_list => 'COUNTRY_ID NUMBER ,
            COUNTRY_ISO_CODE CHAR(2) ,
            COUNTRY_NAME VARCHAR2(40) ,
            COUNTRY_SUBREGION VARCHAR2(30) ,
            COUNTRY_SUBREGION_ID NUMBER ,
            COUNTRY_REGION VARCHAR2(20) ,
            COUNTRY_REGION_ID NUMBER ,
            COUNTRY_TOTAL VARCHAR2(11) ,
            COUNTRY_TOTAL_ID NUMBER ,
            COUNTRY_NAME_HIST VARCHAR2(40)'
     );

    The code snippets you are provided allow you to create an external table directly from your cloud object store. Now you can then query from that external table, outside of the database. Without that code snippet, I would have struggled to do this on my own (or at least, not without some research). That is more of a “me” problem though.

    I appreciate that this method of querying is available, especially if you are only concerned with a small subset of your data. Keeping this data closer to you can certainly make subsequent requests quicker.

    Lab 5

    Here we try our hand at business intelligence. You begin by downloading Oracle Analytics Desktop. The tool reminded me of Tableau or one of the SAS data visualization products that are available. 

    Consider this: Biases aside, Oracle Analytics Desktop is free. And you can connect to your database within a matter of minutes. 
    
    If its forecasting and visualizations you are looking for, this thing looks plenty powerful.

    Much like before, everything is GUI-based. But you can also do much of the set-up in Oracle’s SQL Developer, or from within the browser. With some provided SQL, I defined a table from the data I imported in a previous Lab. From there you get some practice establishing a secure connection to your database, and then import that table into Oracle Analytics Desktop.

    I don’t know if I should spend too much time here, because currently my focus isn’t data analysis/business intelligence. But once you establish a secure connection to your database, you can easily drop and drag data into the tool’s visualization pane and later manipulate the visualizations in countless ways.

    My biggest takeaway here, is that once you have created a wallet from within your OCI dashboard, and established a connection to your data warehouse (from within Oracle’s Analytics Desktop), things are very intuitive. 

    Everything is drag and drop. And since you’ll pre-define and save a subset of your data, you can’t break anything, you can just start over by pulling down subsequent data. Truthfully, if your focus isn’t Business Intelligence, then you can (and some are going to hate this) skim this lab to get the gist.

    The End

    There is a totally optional Lab 6, where you export your newly created project to a .DVA file. But I skimmed that and got the idea.

    Like I mentioned before, this content will become increasingly more technical. I’ll be doing some exploring with the APIs in ORDS. And I’ll see what I can do with flask + python + ORDS. I’ve found some good references on Github and of course I’ll be share the [heavily commented] code here and on Github too!

    And as always, you can find me here:

    Until next time. Love, peace, and chicken grease.