Blob Store API
Managed Fusion Admin APIs
The Blob Store REST API allows storing binary objects in Solr. The primary use case for this is to store entity extraction models, lookup lists or exclusion lists for use in index pipelines. This may include the entity extraction models and lookup lists included with Managed Fusion in the
.
For more information, view the API specification.
The complete list of valid values for
The response is empty.
Verify that the JavaScript blob was uploaded:
REQUEST
RESPONSE
Upload an OpenNLP sentence model binary file to the blob store:
REQUEST
Get the manifest for a sentence OpenNLP model we have previously saved in the blob store:
REQUEST
RESPONSE
Upload a JDBC driver, using slashes in the blob name:
REQUEST
RESPONSE
Get the JDBC driver that was uploaded:
REQUEST
RESPONSE
{fusion_path}/data/nlp directory, or files that you have created on your own.
You can also work with blobs in the Managed Fusion UI using the blob manager.
When you upload a blob without specifying an app, the blob is stored in the system_blobs collection and you can access it via the Use the Object Explorer.
Use the Object Explorer
Use the Object Explorer
LucidAcademyLucidworks offers free training to help you get started.The Quick Learning for Object Explorer Quick Learning focuses on a brief overview of the Object Explorer:
LucidAcademyLucidworks offers free training to help you get started.The Course for The Object Explorer focuses on how to view and manage objects such as collections, datasources, index and query pipelines, index and query profiles, and parsers within apps and share them to other applications:
Get started
How to open Object ExplorerClick System > Object Explorer.Object Explorer opens and displays either a list of all objects in the current app, or the list of objects that match your most recent search in Object Explorer, whether during this Managed Fusion session or a previous session.Search and browse
- Specify the context To restrict the scope of searching and browsing, click In Current App, In Any App, or In No Apps.
- Browse all objects in the context – Specify the context. Object Explorer displays a list of all objects. If you do not see a list of objects, press Enter in the Filter box.
- Search for objects – Specify the context. Type any part of an object’s name or type (the gray, uppercase text below the name, for example,
PARSER) in the Filter box. You can entergroupto search for groups. Enter the search term in any case. Object Explorer displays a list of matching objects. - Display related objects (with a mouse) – With a list of objects present, click an object to select it. Object Explorer centers the object and displays all related objects.
- Display related objects (with Tab keys) – With a list of objects present, tab from object to object. With an object highlighted, press Enter to select it. Object Explorer centers the object and displays all related objects.
- Move backward and forward through a history of results – You can move backward and forward through a history of results, that is, the objects you have browsed to, searched for, and clicked on. To the right of the Filter box, click the arrow keys.
- Determine which apps an object is in – Click In any App. You will see dots on the objects that represent the apps that the objects are in. To view a list of the apps for an object, hover over the object, and then click the App
icon.
Manage objects
- Edit an object’s name – For some objects, for example, Group objects, clicking
lets you edit the object’s name. - Manage an object – For most objects that display the takes you to the part of the Managed Fusion UI where you can manage the object.
- Schedule a job or task – Hover over an object that displays the Schedule
icon when you hover. Click Schedule . From the scheduling dialog, you can click Open Schedule to open the Scheduler.
Group objects
Group objects to easily browse related objects. Managed Fusion groups some objects for you. This is an example of viewing a group, in this case, the_shared group:- System groups (
) - Groups created by Managed Fusion to group objects such as signals and items that are shared among apps. You cannot modify the membership of a system group. - Recommendations groups (
) - Groups related to recommendations. These are a subtype of system groups. You cannot modify the membership of a recommendations group. - User-defined groups (
) - Groups you create and manage yourself. You can put whatever objects you like in them. - Managed Fusion-created groups that are not system groups ( ) - These look and behave like user-defined groups, but you do not create them. Managed Fusion does. You can put objects in them.
- View existing groups – A group is a means of tagging objects with a shared, arbitrary identifier.
-
Create a user-defined group – Hover over an object that you want to add to the group you are creating, and that displays the Add To Group
icon when you hover. Click Add To Group . Enter the name of a new group.
A group name can only contain the characters A-Z,a-z,0-9,-(hyphen), and_(underscore). -
Add an object to a group – Hover over an object that displays the Add To Group icon when you hover. Click Add To Group . Choose an existing group, or enter the name of a new group. You cannot add objects to the group
_shared. Its members are calculated for you. -
Remove an object from a group – Select the group from which you want to remove an object. Object Explorer centers the group. Hover over the object you want to remove, and then click Remove From Group
.
-
Delete a user-defined group – When you remove the last object from a user-defined group, the group remains. To delete it, hover over the group, and then click
.
Share objects among apps
Sharing objects among apps lets you configure something once and use it multiple times where needed. When you share an object, the object and any objects that the objects depends on are shared.Managed Fusion makes intelligent choices regarding what is shared among apps. Exercise caution when adding and removing objects from apps.
- Add an object to an app – While in the Managed Fusion workspace for the app to which you want to add an object, open Object Explorer and click In Any App. Search for or browse to the object you want to add. Hover over the object, click the App icon, and then click Add to this app.
- Add an object to an app directly – In cases when an object is linked to an app, but is not linked directly to the app (it is linked via some dependency), you can add the object to an app directly.
While in the Managed Fusion workspace for the app to which you want to add an object directly, open Object Explorer and click In Any App. Search for or browse to the object you want to add. Hover over the object, click the App icon, and then click Add to this app directly.
- Remove an object from an app – While in the Managed Fusion workspace for the app from which you want to remove an object, open Object Explorer and click In Any App. Search for or browse to the object you want to remove. Hover over the object, click the App icon, and then click Remove.
Close Object Explorer
On a PC or Mac, press Esc or click Close.Blob types
AresourceType query parameter can be used to specify the blob type. For example, specify file:js-index when uploading a Javascript index stage, like this:
resourceType is below:
| Type | Description |
|---|---|
driver:jdbc | A Upload a JDBC Driver to Fusion Server |
file:js-index | A JavaScript file for use with a Managed Javascript index stage |
file:js-query | A JavaScript file for use with a Managed Javascript query stage |
file | Any uploaded file, such as from the Quickstart or the Index Workbench |
unspecified | A blob of unknown type If no resourceType is specified on upload, “other” is assigned by default. |
Upload a JDBC Driver to Fusion Server
Upload a JDBC Driver to Fusion Server
The JDBC connector fetches documents from a relational database via SQL queries. Under the hood, this connector implements the Solr DataImportHandler (DIH) plugin.Fusion stores JDBC drivers in the blob store. You can upload a driver using the Fusion UI or the Blob Store API.
- The JDBC V1 connector is supported in Fusion releases 5.3 and earlier.
- The JDBC V2 connector is supported in Fusion releases 5.4 and later.
How to upload a JDBC driver using the Fusion UI
- In the Fusion UI, navigate to System > Blobs.
- Click Add.
-
Select JDBC Driver.
The “New ‘JDBC Driver’ Upload” panel appears.
-
Click Choose File and select the .jar file from your file system.
-
Click Upload.
The new driver’s blob manifest appears.
How to install a JDBC driver using the API
-
Upload the JAR file to Fusion’s blob store using the
/blobs/{id}endpoint. Specify an arbitrary blob ID, and aresourceTypevalue ofplugin:connector, as in this example:Success response:Fusion automatically publishes the event to the cluster, and the listeners perform the driver installation process on each node.If the blob ID is identical to an existing one, the old driver will be uninstalled and the new driver will installed in its place. To get the list of existing blob IDs, run:curl -u USERNAME:PASSWORD https://FUSION_HOST:FUSION_PORT/api/blobs -
To verify the uploaded driver, run:
Where the
BLOB_IDis the name specified during upload, such as “mydriver” above. A success response looks like this:
How to manually upload a JDBC V1 driver for Fusion 4.x.x releases
For Fusion 4.x.x release levels, it is recommended that you upload the JDBC driver jar files manually. This prevents some issues with dynamically loading the driver causing errors, particularly with Oracle and Microsoft SQL drivers.The following steps specify how to upload a JDBC driver JAR file to Fusion manually. The example uses the Microsoft SQL Server JDBC drivermssql-jdbc-6.6.2-jre8.jar file.- Delete the JDBC V1 driver uploaded using the Blob store upload window.
-
Save the JDBC V1 driver JAR file to the
apps/libfolder. For example:apps\libs\mssql-jdbc-6.2.2.jre8.jar -
Open the
apps/jetty/connectors-classic/webapps/connectors-extra-classpath.txtfile and add the following line:apps/libs/mssql-jdbc-6.2.2.jre8.jar - Restart connectors-classic.
- Specify the JDBC driver class name in the Manually uploaded JDBC Driver Name field.
- Enter com.microsoft.sqlserver.jdbc.SQLServerDriver in the JDBC Driver Name field.
Quickstart
Quickstart
The Quickstart is a wizard that lets you explore some of Managed Fusion’s core capabilities:
- Creating or selecting an app
- Selecting a collection (where data is stored)
- Indexing data
- Searching
LucidAcademyLucidworks offers free training to help you get started.The Course for Using The Quickstart Wizard focuses on using the wizard to practice using the key functions of Fusion:
Step through the Quickstart wizard
If it is not already open, open the Quickstart wizard. In the Managed Fusion launcher, click New here? Get started….-
Click Continue.
On the Select an App screen, you can select or create an app for your quickstart data.
-
After selecting an app, click Continue.
On the Select a Collection screen, you can select or create a collection for your quickstart data. A collection with the same name as your app is created automatically:
-
Click Continue.
On the Index Data screen, you can either select one of the built-in sample datasets or click Use my data to upload your own:
-
Click Continue.
On the Query Data screen, you can see all search results and enter your own search queries to test the indexed dataset. You can also select the display fields or view the parsed documents:
-
Click Continue.
- Open the Index Workbench to change the index pipeline.
- Open the Query Workbench to change the query pipeline.
Examples
Upload a JavaScript file to the blob store: REQUESTIn this example, we have changed the name of the blob during upload by giving it a different ID. The file is named ‘en-sent.bin’ but we have defined the ID of this to ‘sentenceModel.bin’. When we use this blob in an index pipeline, we would refer to it by the ID we have given it.