Merge pull request #17 from OsBlaineOra/ruby-crud

Add Ruby CRUD operations examples.

Author: gvenzl

ruby/CRUD-examples/README.md

@@ -0,0 +1 @@
+The scripts in this directory follow the [BASIC CRUD OPERATIONS USING RUBY-OCI8](https://learncodeshare.net/2016/08/26/basic-crud-operations-using-ruby-oci8/) tutorial found on [LearnCodeShare.net](https://learncodeshare.net).

ruby/CRUD-examples/createDBObjects.sql

@@ -0,0 +1,49 @@
+# The following creates and populates the tables used for the tutorial
+# These scripts use identity columns available in Oracle 12.1. If you are using an older version you will need
+# to add your own trigger/sequence functionality to generate the id values.
+# code Sample from the tutorial at https://learncodeshare.net/2016/08/26/basic-crud-operations-using-ruby-oci8/
+
+CREATE TABLE LCS_PEOPLE (
+ id NUMBER GENERATED BY DEFAULT AS identity,
+ name VARCHAR2(20),
+ age NUMBER,
+ notes VARCHAR2(100)
+)
+/
+
+ALTER TABLE LCS_PEOPLE
+ADD CONSTRAINT PK_LCS_PEOPLE PRIMARY KEY ("ID")
+/
+
+CREATE TABLE LCS_PETS (
+ id NUMBER GENERATED BY DEFAULT AS IDENTITY,
+ name VARCHAR2(20),
+ owner NUMBER,
+ type VARCHAR2(100)
+)
+/
+
+ALTER TABLE LCS_PETS ADD CONSTRAINT PK_LCS_PETS PRIMARY KEY ("ID")
+/
+
+ALTER TABLE LCS_PETS ADD CONSTRAINT FK_LCS_PETS_OWNER FOREIGN KEY ("OWNER") REFERENCES "LCS_PEOPLE" ("ID")
+/
+
+INSERT INTO LCS_PEOPLE (name, age, notes)
+ VALUES ('Bob', 35, 'I like dogs')
+/
+
+INSERT INTO LCS_PEOPLE (name, age, notes)
+ VALUES ('Kim', 27, 'I like birds')
+/
+
+INSERT INTO LCS_PETS (name, owner, type)
+ VALUES ('Duke', 1, 'dog')
+/
+
+INSERT INTO LCS_PETS (name, owner, type)
+ VALUES ('Pepe', 2, 'bird')
+/
+
+COMMIT
+/

ruby/CRUD-examples/delete/extra_fun_1.rb

@@ -0,0 +1,44 @@
+# The example code below executes a simple delete using named bind variables.
+# Code Sample from the tutorial at https://learncodeshare.net/2016/11/09/delete-crud-using-ruby-oci8/
+# section titled "Extra Fun 1"
+
+require 'oci8'
+
+def get_all_rows(label, data_type = 'people')
+ connectString = ENV['DB_CONNECT'] # The environment variable for the connect string: DB_CONNECT=user/password@database
+ con = OCI8.new(connectString)
+
+ # Query all rows
+ statement = 'select id, name, age, notes from lcs_people order by id'
+
+ if data_type == 'pets'
+ statement = 'select id, name, owner, type from lcs_pets order by owner, id'
+ end
+
+ cursor = con.parse(statement)
+ cursor.exec
+ printf " %s:\n", label
+ cursor.fetch do |row|
+ if data_type == 'people'
+ printf " Id: %d, Name: %s, Age: %d, Notes: %s\n", row[0], row[1], row[2], row[3]
+ else
+ printf " Id: %d, Name: %s, Owner: %d, Type: %s\n", row[0], row[1], row[2], row[3]
+ end
+ end
+ printf "\n"
+end
+
+connectString = ENV['DB_CONNECT'] # The environment variable for the connect string: DB_CONNECT=user/password@database
+con = OCI8.new(connectString)
+
+get_all_rows('Original Data', 'pets')
+
+# Example code showing a simple delete using named bind variables.
+statement = 'delete from lcs_pets where type = :type'
+cursor = con.parse(statement)
+cursor.bind_param(:type, 'bird')
+cursor.exec
+con.commit
+# End Example
+
+get_all_rows('New Data', 'pets')

ruby/CRUD-examples/delete/extra_fun_2.rb

@@ -0,0 +1,52 @@
+# The example code below executes two simple deletes using named bind variables.
+# The child records are removed, followed by the parent record.
+# Code Sample from the tutorial at https://learncodeshare.net/2016/11/09/delete-crud-using-ruby-oci8/
+# section titled "Extra Fun 2"
+
+require 'oci8'
+
+def get_all_rows(label, data_type = 'people')
+ connectString = ENV['DB_CONNECT'] # The environment variable for the connect string: DB_CONNECT=user/password@database
+ con = OCI8.new(connectString)
+
+ # Query all rows
+ statement = 'select id, name, age, notes from lcs_people order by id'
+
+ if data_type == 'pets'
+ statement = 'select id, name, owner, type from lcs_pets order by owner, id'
+ end
+
+ cursor = con.parse(statement)
+ cursor.exec
+ printf " %s:\n", label
+ cursor.fetch do |row|
+ if data_type == 'people'
+ printf " Id: %d, Name: %s, Age: %d, Notes: %s\n", row[0], row[1], row[2], row[3]
+ else
+ printf " Id: %d, Name: %s, Owner: %d, Type: %s\n", row[0], row[1], row[2], row[3]
+ end
+ end
+ printf "\n"
+end
+
+connectString = ENV['DB_CONNECT'] # The environment variable for the connect string: DB_CONNECT=user/password@database
+con = OCI8.new(connectString)
+
+get_all_rows('Original People Data', 'people')
+get_all_rows('Original Pet Data', 'pets')
+
+# Example code showing two simple deletes using named bind variables.
+statement = 'delete from lcs_pets where owner = :owner'
+cursor = con.parse(statement)
+cursor.bind_param(:owner, 5)
+cursor.exec
+
+statement = 'delete from lcs_people where id = :id'
+cursor = con.parse(statement)
+cursor.bind_param(:id, 5)
+cursor.exec
+con.commit
+# End Example
+
+get_all_rows('New People Data', 'people')
+get_all_rows('New Pet Data', 'pets')

ruby/CRUD-examples/delete/foreign_keys.rb

@@ -0,0 +1,49 @@
+# The example code below executes a simple delete using named bind variables.
+# When following the tutorial with default data this section intentionally throws an error
+# to demonstrate foreign key functionality.
+# Code Sample from the tutorial at https://learncodeshare.net/2016/11/09/delete-crud-using-ruby-oci8/
+# section titled "Deleting records referenced by Foreign Keys" 1st example
+
+require 'oci8'
+
+def get_all_rows(label, data_type = 'people')
+ connectString = ENV['DB_CONNECT'] # The environment variable for the connect string: DB_CONNECT=user/password@database
+ con = OCI8.new(connectString)
+
+ # Query all rows
+ statement = 'select id, name, age, notes from lcs_people order by id'
+
+ if data_type == 'pets'
+ statement = 'select id, name, owner, type from lcs_pets order by owner, id'
+ end
+
+ cursor = con.parse(statement)
+ cursor.exec
+ printf " %s:\n", label
+ cursor.fetch do |row|
+ if data_type == 'people'
+ printf " Id: %d, Name: %s, Age: %d, Notes: %s\n", row[0], row[1], row[2], row[3]
+ else
+ printf " Id: %d, Name: %s, Owner: %d, Type: %s\n", row[0], row[1], row[2], row[3]
+ end
+ end
+ printf "\n"
+end
+
+connectString = ENV['DB_CONNECT'] # The environment variable for the connect string: DB_CONNECT=user/password@database
+con = OCI8.new(connectString)
+
+get_all_rows('Original People Data', 'people')
+get_all_rows('Original Pet Data', 'pets')
+
+# Example code showing a simple delete using named bind variables.
+# The FK will cause this to throw an error.
+statement = 'delete from lcs_people where id = :id'
+cursor = con.parse(statement)
+cursor.bind_param(:id, 1)
+cursor.exec
+con.commit
+# End Example
+
+get_all_rows('New People Data', 'people')
+get_all_rows('New Pet Data', 'pets')

ruby/CRUD-examples/delete/handle_pets.rb

@@ -0,0 +1,54 @@
+# The example code below executes two simple deletes using named bind variables.
+# The child records are updated to a different parrent,
+# followed by deleting the original parent record.
+# Code Sample from the tutorial at https://learncodeshare.net/2016/11/09/delete-crud-using-ruby-oci8/
+# section titled "Deleting records referenced by Foreign Keys" 2nd example
+
+require 'oci8'
+
+def get_all_rows(label, data_type = 'people')
+ connectString = ENV['DB_CONNECT'] # The environment variable for the connect string: DB_CONNECT=user/password@database
+ con = OCI8.new(connectString)
+
+ # Query all rows
+ statement = 'select id, name, age, notes from lcs_people order by id'
+
+ if data_type == 'pets'
+ statement = 'select id, name, owner, type from lcs_pets order by owner, id'
+ end
+
+ cursor = con.parse(statement)
+ cursor.exec
+ printf " %s:\n", label
+ cursor.fetch do |row|
+ if data_type == 'people'
+ printf " Id: %d, Name: %s, Age: %d, Notes: %s\n", row[0], row[1], row[2], row[3]
+ else
+ printf " Id: %d, Name: %s, Owner: %d, Type: %s\n", row[0], row[1], row[2], row[3]
+ end
+ end
+ printf "\n"
+end
+
+connectString = ENV['DB_CONNECT'] # The environment variable for the connect string: DB_CONNECT=user/password@database
+con = OCI8.new(connectString)
+
+get_all_rows('Original People Data', 'people')
+get_all_rows('Original Pet Data', 'pets')
+
+# Example code showing how to update existing child records before deleting the parent.
+statement = 'update lcs_pets set owner = :newOwner where owner = :oldOwner'
+cursor = con.parse(statement)
+cursor.bind_param(:newOwner, 2)
+cursor.bind_param(:oldOwner, 1)
+cursor.exec
+
+statement = 'delete from lcs_people where id = :id'
+cursor = con.parse(statement)
+cursor.bind_param(:id, 1)
+cursor.exec
+con.commit
+# End Example
+
+get_all_rows('New People Data', 'people')
+get_all_rows('New Pet Data', 'pets')

ruby/CRUD-examples/delete/reset_data.rb

@@ -0,0 +1,49 @@
+# The following resets the data for use with the update section
+# For both tables:
+# Table data is removed.
+# The identity column is set to start with the id after the starting data.
+# Using the executemany function an array of starting data is inserted into the table.
+# Code Sample from the tutorial at https://learncodeshare.net/2016/11/09/delete-crud-using-ruby-oci8/
+# section titled "Resetting the data"
+
+require 'oci8'
+connectString = ENV['DB_CONNECT'] # The environment variable for the connect string: DB_CONNECT=user/password@database
+con = OCI8.new(connectString)
+
+# Delete rows
+cursor = con.parse('delete from lcs_pets')
+cursor.exec
+
+# Reset Identity Coulmn
+cursor = con.parse('alter table lcs_pets modify id generated BY DEFAULT as identity (START WITH 8)')
+cursor.exec
+
+# Delete rows
+cursor = con.parse('delete from lcs_people')
+cursor.exec
+
+# Reset Identity Coulmn
+cursor = con.parse('alter table lcs_people modify id generated BY DEFAULT as identity (START WITH 8)')
+cursor.exec
+
+# Insert default people rows
+cursor = con.parse('INSERT INTO lcs_people(id, name, age, notes) VALUES (:id, :name, :age, :notes)')
+cursor.max_array_size = 7
+cursor.bind_param_array(:id, [1, 2, 3, 4, 5, 6, 7])
+cursor.bind_param_array(:name, %w[Bob Kim Cheryl Bob Stacey Pete Pat])
+cursor.bind_param_array(:age, [35, 27, 23, 27, 45, 23, 36])
+cursor.bind_param_array(:notes, ['I like dogs', 'I like birds', 'I like horses', 'I like rabbits', 'I like snakes', 'I like cats', 'I like dogs'])
+people_row_count = cursor.exec_array
+printf " %d people rows inserted\n", people_row_count
+
+# Insert default pet rows
+cursor = con.parse('INSERT INTO lcs_pets(id, name, owner, type) VALUES (:id, :name, :owner, :type)')
+cursor.max_array_size = 7
+cursor.bind_param_array(:id, [1, 2, 3, 4, 5, 6, 7])
+cursor.bind_param_array(:name, %w[Duke Dragon Sneaky Red Red Buster Fido])
+cursor.bind_param_array(:owner, [1, 2, 5, 2, 3, 1, 7])
+cursor.bind_param_array(:type, %w[dog bird snake bird horse dog cat])
+pet_row_count = cursor.exec_array
+printf " %d pet rows inserted\n", pet_row_count
+
+con.commit

ruby/CRUD-examples/delete/simple.rb

@@ -0,0 +1,44 @@
+# The example code below executes a simple delete using named bind variables.
+# Code Sample from the tutorial at https://learncodeshare.net/2016/11/09/delete-crud-using-ruby-oci8/
+# section titled "Simple delete"
+
+require 'oci8'
+
+def get_all_rows(label, data_type = 'people')
+ connectString = ENV['DB_CONNECT'] # The environment variable for the connect string: DB_CONNECT=user/password@database
+ con = OCI8.new(connectString)
+
+ # Query all rows
+ statement = 'select id, name, age, notes from lcs_people order by id'
+
+ if data_type == 'pets'
+ statement = 'select id, name, owner, type from lcs_pets order by owner, id'
+ end
+
+ cursor = con.parse(statement)
+ cursor.exec
+ printf " %s:\n", label
+ cursor.fetch do |row|
+ if data_type == 'people'
+ printf " Id: %d, Name: %s, Age: %d, Notes: %s\n", row[0], row[1], row[2], row[3]
+ else
+ printf " Id: %d, Name: %s, Owner: %d, Type: %s\n", row[0], row[1], row[2], row[3]
+ end
+ end
+ printf "\n"
+end
+
+connectString = ENV['DB_CONNECT'] # The environment variable for the connect string: DB_CONNECT=user/password@database
+con = OCI8.new(connectString)
+
+get_all_rows('Original Data', 'pets')
+
+# Example code showing a simple delete using named bind variables.
+statement = 'delete from lcs_pets where id = :id'
+cursor = con.parse(statement)
+cursor.bind_param(:id, 1)
+cursor.exec
+con.commit
+# End Example
+
+get_all_rows('New Data', 'pets')

ruby/CRUD-examples/delete/template.rb

@@ -0,0 +1,39 @@
+# The following code is used as the base template for the other examples.
+# It is intended to be helper code not part of the examples.
+# Code Sample from the tutorial at https://learncodeshare.net/2016/11/09/delete-crud-using-ruby-oci8/
+# section titled "Boilerplate template"
+
+require 'oci8'
+
+def get_all_rows(label, data_type = 'people')
+ connectString = ENV['DB_CONNECT'] # The environment variable for the connect string: DB_CONNECT=user/password@database
+ con = OCI8.new(connectString)
+
+ # Query all rows
+ statement = 'select id, name, age, notes from lcs_people order by id'
+
+ if data_type == 'pets'
+ statement = 'select id, name, owner, type from lcs_pets order by owner, id'
+ end
+
+ cursor = con.parse(statement)
+ cursor.exec
+ printf " %s:\n", label
+ cursor.fetch do |row|
+ if data_type == 'people'
+ printf " Id: %d, Name: %s, Age: %d, Notes: %s\n", row[0], row[1], row[2], row[3]
+ else
+ printf " Id: %d, Name: %s, Owner: %d, Type: %s\n", row[0], row[1], row[2], row[3]
+ end
+ end
+ printf "\n"
+end
+
+connectString = ENV['DB_CONNECT'] # The environment variable for the connect string: DB_CONNECT=user/password@database
+con = OCI8.new(connectString)
+
+get_all_rows('Original Data', 'pets')
+
+# Your code here
+
+get_all_rows('New Data', 'pets')

ruby/CRUD-examples/dropDBObjects.sql

@@ -0,0 +1,8 @@
+# The following drops the tables created for the tutorial
+# code Sample from the tutorial at https://learncodeshare.net/2016/08/26/basic-crud-operations-using-ruby-oci8/
+
+drop table LCS_PETS
+/
+
+drop table LCS_PEOPLE
+/