SearchBlox

SearchBlox Developer Hub

Welcome to the SearchBlox developer hub. Here you will find comprehensive guides and documentation to help you start working with SearchBlox as quickly as possible, as well as support if you get stuck. Let's jump right in!

Guides

Database Connection Settings

For successful connection and indexing, Database Collection settings and queries must be correct.
To index databases like MySql, SQL Server, Oracle and PostgreSQL, you must provide the following data in the settings:

  • Database Type
  • Host IP/Name
  • Host Port No.
  • Database Name
  • Database Username
  • Database Password

Apache Drill and other application connectors require only the Database URL String.

MySQL Settings

SQL Server Settings

SearchBlox supports MS SQL Server versions later than 2012.

SQL Server Configuration
SQL Server has a dynamic port. In order to set the listening port (the host port in the image), follow the steps shown here: http://msdn.microsoft.com/en-us/library/ms177440.aspx.

Enter the port number in the dynamic port (see screenshots).

  1. Enter 1433 as the dynamic port for 10.200.2.9 and 127.0.0.1, and nothing in TCP port.
  2. If there are other IPs, enter 0 as the dynamic port.
  3. In IPAll, enter 1433 as TCP Port.
  4. Restart SQL Server and test the connection in SearchBlox.
    (ref: https://www.spdockit.com/support/help/faq/troubleshooting-sql-server/configure-sql-server-listen-specific-port/)

Oracle Settings

Postgre SQL

Apache Drill Settings

For Apache Drill and other databases, you need to specify the Database URL string alone. The following are prerequisites for Apache Drill databases:
https://drill.apache.org/docs/embedded-mode-prerequisites/.

Database Settings for Other Databases

Database URL String for Database Drivers
The sample query, settings with database URL string, and the list of other databases supported by SearchBlox are provided below.

The sample query across all databases:

SELECT field1 as uid, field2 as title, field3 as content FROM usertable
SELECT * FROM usertable

.Database Collection Settings

Database Name
Database URL String
Sample Query

Active Directory

jdbc:activedirectory:user=myuseraccount;password=mypassword;

Apache Drill

jdbc:drill:drillbit=localhost

Authorize.Net

jdbc:authorizedotnet:LoginID=myLoginID;TransactionKey=myTransactionKey;Url=myUrl

Azure Table

jdbc:azure:AccessKey=myAccessKey;Account=myAccountName;

SELECT * FROM NorthwindProducts
http://cdn.cdata.com/help/CAA/jdbc/pg_select.htm

Cassandra

jdbc:cassandra:Database=MyCassandraDB;Port=7000;Server=127.0.0.1;

Couchbase

jdbc:couchbase:User='myusername';Password='mypassword';Server='http://couchbase40'

Dynamics CRM

dbc:dynamicscrm:User=myuseraccount;Password=mypassword;
URL=https://myOrg.crm.dynamics.com/;CRM Version=CRM Online;

Dynamics GP

jdbc:dynamicsgp:CompanyId=-1;user=myuser;password=mypassword;
URL= http://{servername}:{port}/Dynamics/GPService

Dynamics NAV

jdbc:dynamicsnav:URL=http://myserver:7048;
User=myserver\Administrator;Password=admin;
ServerInstance=DYNAMICSNAV71;

DynamoDB

jdbc:dynamodb:Access Key=xxx;Secret Key=xxx;
Domain=amazonaws.com;Region=OREGON;

Elasticsearch

jdbc:crate://localhost:4300

select array_field from my_table
https://crate.io/docs/reference/jdbc/

Eloqua

jdbc:eloqua:User=user;Password=password;Company=RSSBus

Email

jdbc:email+:Port=993;Server=imap.gmail.com;Password=password;User=user;
Protocol=IMAP;SMTP Port=587;SMTP Server=smtp.gmail.com;

Exact Online

jdbc:exactonline:Region='United States';Division=5512;

Excel

jdbc:excel:Excel File=C:\MyExcelWorkbooks\SampleWorkbook.xlsx;

Excel Services

jdbc:excelservices:Url=https://myorg.sharepoint.com;
User=admin@myorg.onmicrosoft.com;Password=password;File=Book1.xlsx;

Facebook

jdbc:facebook:OAuthAccessToken=123asjdh912;

SELECT ID as uid, ToData as title, FromName as description FROM Posts LIMIT 300
SELECT FROM Groups WHERE SearchTerms = 'facebook'
SELECT
FROM Users WHERE SearchTerms = 'facebook'
http://cdn.cdata.com/help/RBA/jdbc/pg_select.htm

Gmail

jdbc:gmail:user=myuseraccount;password=mypassword;

SELECT ID as uid, Subject as title, To as description, MessageBody as content FROM Inbox LIMIT 200
http://cdn.cdata.com/help/DLA/jdbc/pg_select.htm

Google AdWords

jdbc:googleadwords:OAuth Access Token=myAccessToken;
DeveloperToken=myDeveloperToken;
ClientCustomerId=myClientCustomerId;

SELECT * FROM CampaignPerformance
http://cdn.cdata.com/help/DZA/jdbc/pg_select.htm

Google Analytics

jdbc:googleanalytics:OAuth Access Token=myAccessToken;

Google Apps

jdbc:googleapps:OAuth Access Token=myAccessToken;

Google Sheets

jdbc:googlesheets:OAuthAccessToken=myOAuthAccessToken;
Spreadsheet=SpreadsheetName;

GoogleBigQuery

jdbc:googlebigquery:OAuthAccessToken=MyOAuthAccessToken;ProjectId=NameOfProject;
DatasetId=NameOfDataset

SELECT * FROM publicdata:samples.github_nested
http://cdn.cdata.com/help/DBB/jdbc/pg_select.htm

HBase

jdbc:apachehbase:Server=127.0.0.1;Port=8080;

HPCC

jdbc:hpcc:URL=http://127.0.0.1:8510;User=test;password=xA123456;
Version=1;Cluster=hthor;

SELECT * FROM hpcc::test::person
http://cdn.cdata.com/help/CHA/jdbc/pg_select.htm

HubSpot

jdbc:hubspot:OAuth Access Token=11111-AAAAA-33333;

LDAP

jdbc:ldap:user=myuseraccount;password=mypassword;

Magento

jdbc:magento:OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;
OAuthAccessToken=MyOAuthAccessToken;OAuthAccessTokenSecret=MyOAuthAccessTokenSecret;
BaseApiUrl=MyBaseApiUrl

Marketo

jdbc:marketo:UserId=myuserid;EncryptionKey=myencryptionkey;

MongoDB

jdbc:mongodb:Server=127.0.0.1;Port=27017;Database=test;User=test/;

OData

jdbc:odata:user=myuseraccount;password=mypassword;URL=http://myserver/myOrgRoot;

Office 365

jdbc:office365:OAuthAccessToken=MyOAuthAccessToken;OAuthCallbackURL=http://localhost:33333

Quandl

jdbc:quandl:ApiKey=abc123;DatabaseCode=WIKI

QuickBooks

jdbc:quickbooks:user=myuseraccount;password=mypassword;
URL=http://localhost:2080;

QuickBooks Online

jdbc:quickbooksonline:OAuthAccessToken=ABC;OAuthAccessTokenSecret=DEF;
OAuthClientID=123;OAuthClientIDSecret=456;CompanyId=555555;UseSandbox=True

QuickBooks POS

jdbc:quickbookspos:user=myuseraccount;password=mypassword;URL=http://localhost:2080;qbxmlversion=3.0;

Sage 50 UK

jdbc:sage50uk:URL=http://localhost:5493/sdata/accounts50/GCRM/
{C4C863BE-B098-4A7D-A78B-D7A92B8ADB59};User=Manager;Password=xxxxxx;

Salesforce

jdbc:salesforce:User=username;Password=password;Security Token=sa;

SAP

jdbc:sap:Host=sap.mydomain.com;User=EXT90033;Password=xxx;Client=800;System Number=09;ConnectionType=Classic;Location=C:\mysapschemafolder;

ServiceNow

jdbc:servicenow:OAuthAccessToken=MyOAuthAccessToken;Instance=MyInstance;

SharePoint

jdbc:sharepoint:user=myuseraccount;password=mypassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;
For Sharepoint Online:
jdbc:sharepoint:user=myuseraccount;password=mypassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;SharePointEdition=SharePoint Online;

SimpleDB

jdbc:simpledb:Access Key=My Amazon Access Key;
Secret Key=My Amazon Secret Key;

Solr

jdbc:solr://127.0.0.1:9983?collection=gettingstarted&aggregationMode=map_reduce&numWorkers=1

SELECT id, name FROM gettingstarted ORDER BY id
https://sematext.com/blog/2016/04/26/solr-6-as-jdbc-data-source/

SugarCRM

jdbc:sugarcrm:OAuth Client Id=MyConsumerKey;
OAuth Client Secret=MyConsumerSecret;

Twilio

jdbc:youtube:OAuthAccessToken=MyOAuthAccessToken;CallbackURL=http://localhost:33333

Twitter

jdbc:twitter:OAuth Access Token Secret=123456789;OAuth Access Token=abc123;
OAuth Client Id=XXXXX;OAuth Client Secret=YYYYY;

Xero

jdbc:xero:OAuthclientId=xxxxx;OAuthClientSecret=xxxxx;OAuthAccessToken=xxxxxx;

YouTube

jdbc:youtube:OAuthAccessToken=MyOAuthAccessToken;CallbackURL=http://localhost:33333

ZohoCRM

jdbc:zohocrm:User='user@email.com';Password='myPassword';
AuthToken='1a2b3c4d5e6f...';

Microsoft Exchange

jdbc:exchange:User='myUser@mydomain.onmicrosoft.com';Password='myPassword';Server='https://outlook.office365.com/EWS/Exchange.asmx';Platform='Exchange_Online';

Database Connection Settings


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.