Files
flipper/desktop/plugins/public/databases/docs/setup.mdx
Kevin Strider 567fb5d623 databases (setup)
Summary: Restyle of the page, including changes to spelling, grammar, links, and structure (where relevant).

Reviewed By: nikoant

Differential Revision: D35579365

fbshipit-source-id: cb04b5e839b3d4ae74c4a20dd4a2fadd853d4181
2022-04-13 02:44:11 -07:00

63 lines
1.9 KiB
Plaintext

:::note
To use the databases plugin, you need to add it to your Flipper client instance.
The plugin is currently only available for Android.
:::
## Android
To use the database plugin, instantiate and add the plugin in `FlipperClient`, as shown in the following code:
```java
import com.facebook.flipper.plugins.databases.DatabasesFlipperPlugin;
client.addPlugin(new DatabasesFlipperPlugin(context));
```
By default, it will list all Sqlite databases returned by the context. If you are storing a Sqlite database somewhere else, you can specify a `File` to it:
```java
client.addPlugin(new DatabasesFlipperPlugin(new SqliteDatabaseDriver(context, new SqliteDatabaseProvider() {
@Override
public List<File> getDatabaseFiles() {
List<File> databaseFiles = new ArrayList<>();
for (String databaseName : context.databaseList()) {
databaseFiles.add(context.getDatabasePath(databaseName));
}
databaseFiles.add("...path_to_your_db...")
return databaseFiles;
}
})));
```
If you use a different type of database other than Sqlite, you can implement a driver to be able to access it via Flipper:
```java
client.addPlugin(new DatabasesFlipperPlugin(new DatabaseDriver(context) {
@Override
public List getDatabases() {
return null;
}
@Override
public List<String> getTableNames(DatabaseDescriptor databaseDescriptor) {
return null;
}
@Override
public DatabaseGetTableDataResponse getTableData(DatabaseDescriptor databaseDescriptor, String table, String order, boolean reverse, int start, int count) {
return null;
}
@Override
public DatabaseGetTableStructureResponse getTableStructure(DatabaseDescriptor databaseDescriptor, String table) {
return null;
}
@Override
public DatabaseExecuteSqlResponse executeSQL(DatabaseDescriptor databaseDescriptor, String query) {
return null;
}
}));
```