Back to Top

Create a geodatabase in Db2

In this topic

  1. Prerequisites
  2. Install and configure Db2
  3. Configure clients
  4. Create a geodatabase

Available with Standard or Advanced license.

Install and configure IBM Db2 and an ArcGIS client and use the Enable Enterprise Geodatabase geoprocessing tool or a Python script to create a geodatabase in a Db2 database.

When you create a geodatabase from ArcGIS Pro 3.4, the geodatabase version is 11.4.0.x.

Prerequisites

Complete the following before you create a geodatabase in Db2 on Linux, UNIX, or Windows:

  • Confirm the ArcGIS, Db2, and operating system versions you want to use are compatible.
  • Obtain the Db2 client required to connect to the version of Db2 you'll use to store the geodatabase.
  • Obtain an ArcGIS Server keycodes file—which is created when you authorize ArcGIS Server—and place it in a location you can access from the ArcGIS client you'll use to create the geodatabase.
  • Install and configure Db2.

Install and configure Db2

Before you can run the Enable Enterprise Geodatabase tool or script to create a geodatabase in Db2, you (or your IT department or database administrator) must install and configure the Db2 database management system.

First follow the instructions provided by IBM to install and configure the Db2 instance. Then follow these steps to configure a database and login to use for your geodatabase:

  1. Create an operating system login named sde on the Db2 server.

    You will connect to the database with the sde login to create a geodatabase.

  2. Create a Db2 database and register it with the Spatial Extender module.
  3. Grant the sde user DBADM authority in the database.
  4. Create a temporary table space and grant geodatabase users access to the table space.

    The temporary table space must have a minimum of 8K of page space.

    In the following example, a user temporary table space named geospace is created with page size 8K. Use of the table space is granted to a group named geodatausers, which contains all database users who perform geodatabase operations such as creating geodatabase archives, using feature bins, and making large selection sets that generate log file tables in the geodatabase.

    CREATE USER TEMPORARY TABLESPACE geospace PAGESIZE 8 K MANAGED BY AUTOMATIC STORAGE BUFFERPOOL IBMDEFAULTBP;

GRANT USE OF TABLESPACE geospace TO geodatausers WITH GRANT OPTION;

Next, configure the ArcGIS client from which you will connect and create a geodatabase in the Db2 database.

Configure clients

You can run a Python script from ArcGIS Pro (Desktop Standard or Desktop Advanced) or ArcGIS Server (enterprise edition) to create a geodatabase. To run the Enable Enterprise Geodatabase geoprocessing tool instead of a script, use ArcGIS Pro.

Note:

You need an ArcGIS Server (enterprise) keycodes file to authorize your geodatabase in the next section. Even if you do not run a Python script from an ArcGIS Server machine to create the geodatabase, you must install and authorize ArcGIS Server to get the keycodes file. You may need to copy the file from the ArcGIS Server machine to a location the geoprocessing tool or Python script can access.

  1. Install the ArcGIS client you'll use to create the geodatabase.

    Follow the instructions provided in the software installation guides.

  2. In most cases, the ArcGIS client will be installed on a different computer than the Db2 server; therefore, install and configure a Db2 client on the ArcGIS client computer.

    You can download the IBM Data Server Runtime Client for Db2 from My Esri, or you can use your own installation of the Db2 client. See the Db2 documentation for instructions to install. If you are installing the Db2 client on a 64-bit operating system, run the 64-bit executable; it installs both 32- and 64-bit files, allowing you to connect from both 32- and 64-bit ArcGIS clients.

  3. Optionally, catalog the database to allow connections using a data source name.

    See the IBM Db2 documentation for instructions on creating a data source name.

    A data source name is not required to connect from ArcGIS to a Db2 database; you can use a DSNless connection string instead.

Now you can create a geodatabase.

Create a geodatabase

Use one of the following methods to create a geodatabase in the Db2 database:

Use the Enable Enterprise Geodatabase tool

If you installed and configured ArcGIS Pro to connect to your Db2 database, you can run the Enable Enterprise Geodatabase tool.

Follow these steps to create a geodatabase from ArcGIS Pro:

  1. Start ArcGIS Pro.
  2. Connect to the Db2 database using the sde login.

    Save the sde user's password on the Database Connection dialog box. If you do not, the connection file will not work with the Enable Enterprise Geodatabase tool.

  3. Open the Enable Enterprise Geodatabase tool.
  4. Add the database connection file for your Db2 database to the Input Database text box.
  5. Browse to the ArcGIS Server keycodes file that was created when you authorized ArcGIS Server and add the file to the Authorization File text box.

    When you use the wizard to authorize ArcGIS Server, a keycodes file is written to the machine where the software is installed. If you have not already done so, authorize ArcGIS Server to create this file. If you authorize ArcGIS Server on a Linux machine, the file was created in /arcgis/server/framework/runtime/.wine/drive_c/Program Files/ESRI/License<release>/sysgen. If you authorize on a Microsoft Windows server, the file was created in Program Files\ESRI\License<release>\sysgen. Copy this file to a location you can access from the Enable Enterprise Geodatabase tool.

  6. Click Run.

    You can find messages related to geodatabase creation in the sde_setup.log file, which is created in the directory specified for the %TEMP% variable on the computer where the tool is run. If you have problems creating a geodatabase, check this file to troubleshoot the problem.

A geodatabase is created in the Db2 database.

Next, create users to load data into the geodatabase. See the IBM Db2 Information Center for instructions on creating users.

Use a Python script

You can run a Python script from an ArcGIS Pro (Desktop Standard or Desktop Advanced) or ArcGIS Server (enterprise edition) client machine to create a geodatabase in a Db2 database.

Follow these steps to run a Python script for geodatabase creation in a Db2 database:

  1. Create a text file on the ArcGIS client machine and copy the following script into the file: 

    """
Name: enable_enterprise_gdb.py
Description: Provide connection information to an enterprise database
and enable enterprise geodatabase.
Type enable_enterprise_gdb.py -h or enable_enterprise_gdb.py --help for usage
"""

# Import system modules
import arcpy, os, optparse, sys


# Define usage and version
parser = optparse.OptionParser(usage = "usage: %prog [Options]", version="%prog 1.0 for " + arcpy.GetInstallInfo()['Version'] )

#Define help and options
parser.add_option ("--DBMS", dest="Database_type", type="choice", choices=['SQL_SERVER', 'ORACLE', 'POSTGRESQL', 'DB2','INFORMIX','DB2ZOS', ''], default="", help="Type of enterprise DBMS:  SQL_SERVER, ORACLE, POSTGRESQL, DB2, INFORMIX, or DB2ZOS.")
parser.add_option ("-i", dest="Instance", type="string", default="", help="DBMS instance name")
parser.add_option ("--auth", dest="account_authentication", type ="choice", choices=['DATABASE_AUTH', 'OPERATING_SYSTEM_AUTH'], default='DATABASE_AUTH', help="Authentication type options (case-sensitive):  DATABASE_AUTH, OPERATING_SYSTEM_AUTH.  Default=DATABASE_AUTH")
parser.add_option ("-u", dest="User", type="string", default="", help="Geodatabase administrator user name")
parser.add_option ("-p", dest="Password", type="string", default="", help="Geodatabase  administrator password")
parser.add_option ("-D", dest="Database", type="string", default="none", help="Database name:  Not required for Oracle")
parser.add_option ("-l", dest="Authorization_file", type="string", default="", help="Full path and name of authorization file")


# Check if value entered for option
try:
	(options, args) = parser.parse_args()

	
#Check if no system arguments (options) entered
	if len(sys.argv) == 1:
		print("%s: error: %s\n" % (sys.argv[0], "No command options given"))
		parser.print_help()
		sys.exit(3)
	

	#Usage parameters for spatial database connection
	database_type = options.Database_type.upper()
	instance = options.Instance
	account_authentication = options.account_authentication.upper()
	username = options.User.lower() 
	password = options.Password	
	database = options.Database.lower()
	license = options.Authorization_file


	if( database_type ==""):	
		print(" \n%s: error: \n%s\n" % (sys.argv[0], "DBMS type (--DBMS) must be specified."))
		parser.print_help()
		sys.exit(3)		
		
	if (license == ""):
		print(" \n%s: error: \n%s\n" % (sys.argv[0], "Authorization file (-l) must be specified."))
		parser.print_help()
		sys.exit(3)

		
	# Get the current product license
	product_license=arcpy.ProductInfo()
	
	if (license == ""):
		print(" \n%s: error: %s\n" % (sys.argv[0], "Authorization file (-l) must be specified."))
		parser.print_help()
		sys.exit(3)
	
	# Checks required license level
	if product_license.upper() == "ARCVIEW" or product_license.upper() == 'ENGINE':
		print("\n" + product_license + " license found!" + "  Enabling enterprise geodatabase functionality requires an ArcGIS Desktop Standard or Advanced, ArcGIS Engine with the Geodatabase Update extension, or ArcGIS Server license.")
		sys.exit("Re-authorize ArcGIS before enabling an enterprise geodatabase.")
	else:
		print("\n" + product_license + " license available!  Continuing to enable...")
		arcpy.AddMessage("+++++++++")
	
	# Local variables
	instance_temp = instance.replace("\\","_")
	instance_temp = instance_temp.replace("/","_")
	instance_temp = instance_temp.replace(":","_")
	Conn_File_NameT = instance_temp + "_" + database + "_" + username    
	
	if os.environ.get("TEMP") == None:
		temp = "c:\\temp"	
	else:
		temp = os.environ.get("TEMP")
	
	if os.environ.get("TMP") == None:
		temp = "/usr/tmp"		
	else:
		temp = os.environ.get("TMP")  
	

	Connection_File_Name = Conn_File_NameT + ".sde"
	Connection_File_Name_full_path = temp + os.sep + Conn_File_NameT + ".sde"
	
	# Check for the .sde file and delete it if present
	arcpy.env.overwriteOutput=True
	if os.path.exists(Connection_File_Name_full_path):
		os.remove(Connection_File_Name_full_path)
	
	print("\nCreating Database Connection File...\n")	
	# Process: Create Database Connection File...
	# Usage:  out_file_location, out_file_name, DBMS_TYPE, instnace, database, account_authentication, username, password, save_username_password(must be true)
	arcpy.CreateDatabaseConnection_management(out_folder_path=temp, out_name=Connection_File_Name, database_platform=database_type, instance=instance, database=database, account_authentication=account_authentication, username=username, password=password, save_user_pass="TRUE")
	for i in range(arcpy.GetMessageCount()):

                if "000565" in arcpy.GetMessage(i):   #Check if database connection was successful

                        arcpy.AddReturnMessage(i)

                        arcpy.AddMessage("\n+++++++++")

                        arcpy.AddMessage("Exiting!!")

                        arcpy.AddMessage("+++++++++\n")

                        sys.exit(3)

                else:

                        arcpy.AddReturnMessage(i)

                        arcpy.AddMessage("+++++++++\n")
	
	# Process: Enable geodatabase...
	try:
		print("Enabling Enterprise Geodatabase...\n")
		arcpy.EnableEnterpriseGeodatabase_management(input_database=Connection_File_Name_full_path, authorization_file=license)
		for i in range(arcpy.GetMessageCount()):
			arcpy.AddReturnMessage(i)
		arcpy.AddMessage("+++++++++\n")
	except:
		for i in range(arcpy.GetMessageCount()):
			arcpy.AddReturnMessage(i)
			
	if os.path.exists(Connection_File_Name_full_path):
		os.remove(Connection_File_Name_full_path)
			
#Check if no value entered for option	
except SystemExit as e:
	if e.code == 2:
		parser.usage = ""
		print("\n")
		parser.print_help() 
		parser.exit(2)

  2. Save the file with a .py extension.
  3. Run the script, providing options and information specific to your site.

    In the following example run from a Microsoft Windows machine, the file enable_gdb.py is run for database spdata on instance db2prod. The connection is made as the sde login with password Tgdbst@rtsh3r3. A keycodes file in the default ArcGIS Server location is specified to authorize the geodatabase.

    enable_gdb.py --DBMS DB2 -i db2prod --auth DATABASE_AUTH 
-u sde -p Tgdbst@rtsh3r3 -D spdata -l '\\Program Files\ESRI\License\sysgen\keycodes'

    This is an example of running the script on a Linux machine:

    /enable_gdb.py --DBMS DB2 -i db2prod --auth DATABASE_AUTH 
-u sde -p Tgdbst@rtsh3r3 -D spdata -l '/usr/arcgis/server/framework/runtime/.wine/drive_c/Program Files/ESRI/License/sysgen/keycodes'
    Tip:

    Type -h or --help at the command prompt to get syntax help.

    You can find messages related to geodatabase creation in the sde_setup.log file, which is created in the directory specified for your TEMP or TMP variable on the computer where the Python script is run. If you have any problems creating a geodatabase, check this file to troubleshoot the problem.

A geodatabase is created in your Db2 database.

Next, create users to load data into the geodatabase. See the IBM Db2 Information Center for instructions on creating users and granting privileges to load data.

Feedback on this topic?

In this topic
  1. Prerequisites
  2. Install and configure Db2
  3. Configure clients
  4. Create a geodatabase