|
Accessing the Edgar DB
|
- When you subscribe, we'll provide you a user name and password and a hostname that allows you to access our Postgres 8.3
Edgar Database with up to 1 concurrent sessions.
- If you purchase a corporate or university subscription, we'll configure for up to 4 simultaneous accessors and will allow
your credentials to access from any IP range on a list that you provide.
- You access with any database client, or JDBC or ODBC, from a program on Postgres 8.3's
standard port of 5432 or using a postgres or an open sql client.
- The edgar data is loaded into tables in the database named 'edgar.'
- Your user will also be given a database in the same name as the user. So user Fred will given a
database Fred in which he may construct any tables he requires to use and analyze the XBRL Cloud
Edgar data.
- Your firewall will have to allow outgoing connections to port 5432. Most firewalls these days
allow outgoing connections to almost any IP and port range. If you can not connect, please
check with your system administrator that TCP port 5432 is open outgoing and then
contact us at support@xbrlcloud.com.
- Installation instructions for various clients are shown below, but you may need to contact your
systems administrator to install these clients on your machine.
- Ubuntu or Debian Linux: apt-get install postgresql-client-8.3
- Redhat or Centos: Your YUM repository should contains a client RPM such as
postgresqlclient81-8.1.9-1.el5s2.src.rpm and the command "yum install postgresqlclient81"
should find and install this for you.
- Windows
- You may have your favorite SQL client access tool, but if not the most
popular SQL access tool for Postgres is pgAdmin.
- You can download and run its installer from
http://www.pgadmin.org/download/windows.php
-
When you have installed pgAdmin select the client from the start-> All Programs menu.
-
The upper left hand icon is a plug that allows you to setup your connection to a database,
specify the provided host name (edgardb-1.xbrlcloud.com by default), username and password
and then connect.
-
You will see the host appear under Servers in the left-most pane. Click on it and
then select the Edgar or your user Database and you can enter sql commands in the sql
pane.
|
An example access session is:
psql -h edgardb-1.xbrlcloud.com edgar user
Password psql -h edgardb-1.xbrlcloud.com edgar user
Password for user user:
Welcome to psql 8.3.8 (server 8.3.7), the PostgreSQL interactive terminal.
Type: \copyright for distribution terms
\h for help with SQL commands
\? for help with psql commands
\g or terminate with semicolon to execute query
\q to quit
SSL connection (cipher: DHE-RSA-AES256-SHA, bits: 256)
edgar=> \dt
List of relations
Schema | Name | Type | Owner
--------+-------------------------------------+-------+----------
public | accession | table | postgres
...
public | context | table | postgres
...
public | uri | table | postgres
(31 rows)
edgar=> select count(*) from accession;
count
-------
940
(1 row)
|
|
Easy java starting point
|
We also provide a working HelloEdgarDB java application that you can easily extend to
get you using the Edgar data ASAP.
- Download HelloEdgar.zip
- Install a Java 1.6 and apache Ant,
- simply unzip HelloEdgar.zip
- edit build.xml to change the username and password
- run ant clean HelloEdgarDB
- and you have a working example of how to read the Edgar Data.
|
A sample lists all of the SEC corporate codes for public companies and looks like this:
ant clean HelloEdgarDB
Buildfile: build.xml
clean:
init:
[mkdir] Created dir: /home/user/HelloEdgarDB/build
[mkdir] Created dir: /home/user/HelloEdgarDB/build/lib
[mkdir] Created dir: /home/user/HelloEdgarDB/build/classes
[mkdir] Created dir: /home/user/HelloEdgarDB/build/src
compile:
[javac] Compiling 1 source file to /home/user/HelloEdgarDB/build/classes
jar:
[jar] Building jar: /home/user/HelloEdgarDB/build/lib/HelloEdgarDB.jar
dist:
HelloEdgarDB:
[java] Connection to PostgreSQL 8.3.7 successful.
[java]
[java] Now executing the command: select entity_id, entity_code, authority_scheme, entity_name from entity;
[java] which shows all of the id company name mappings of the SEC.
[java] entity_id entity_code authority_scheme entity_name
[java] 1 796343 http://www.sec.gov/CIK ADOBE SYSTEMS INC
[java] 2 797468 http://www.sec.gov/CIK OCCIDENTAL PETROLEUM CORPORATION
[java] 3 793952 http://www.sec.gov/CIK HARLEY DAVIDSON INC
[java] 4 106535 http://www.sec.gov/CIK WEYERHAEUSER CO
[java] 5 18230 http://www.sec.gov/CIK Caterpillar Inc.
[java] 6 318154 http://www.sec.gov/CIK AMGEN INC
[java] 7 316206 http://www.sec.gov/CIK Starwood Hotel & Resorts Worldwide Inc
[java] 8 1001838 http://www.sec.gov/CIK SOUTHERN COPPER CORPORATION
...
BUILD SUCCESSFUL
Total time: 3 seconds
|
