Change options in Show Entries #records dropdown

[zwickera]

For the table visualization type, there's a dropdown that restricts the # rows that show for a user per page:

Currently this has options for 10 to 200, and an All option.

Is it possible to configure/expand these options, to allow, for example, 500 or 1000 results per page? Can the list of available options for this dropdown be configured via the superset interface, and if so, where? Or can it be modified via a configuration file, or elsewhere?

Any help would be most appreciated, thanks.

[dosubot[bot]]

Hey @zwickera! I'm here to assist you with any issues or questions you have. I'm a bot designed to help you solve bugs, answer questions, and become a contributor.

Yes, it is possible to configure or expand the options in the "Show Entries" dropdown for the table visualization type in Superset to include 500 or 1000 results per page. This can be achieved by modifying the PAGE_SIZE_OPTIONS constant in the superset-frontend/plugins/plugin-chart-table/src/DataTable/DataTable.tsx file.

To include 500 or 1000 results per page, you need to add these values to the PAGE_SIZE_OPTIONS array. Here is how you can do it:

// Import the PAGE_SIZE_OPTIONS constant
import { PAGE_SIZE_OPTIONS } from '../consts';

// Add 500 and 1000 to the PAGE_SIZE_OPTIONS array
const PAGE_SIZE_OPTIONS = [
  [10, '10'],
  [25, '25'],
  [50, '50'],
  [100, '100'],
  [500, '500'],  // Add 500
  [1000, '1000'],  // Add 1000
];

By adding these values, the "Show Entries" dropdown will now include options for 500 and 1000 results per page ^[1].

Additionally, you can make these changes configurable through the Superset UI or a configuration file, rather than modifying the source code directly. You can create a configuration module, typically a file named superset_config.py, and override the necessary parameters. This file can be added to your PYTHONPATH or specified using the SUPERSET_CONFIG_PATH environment variable.

For example:

export SUPERSET_CONFIG_PATH=/app/superset_config.py

Or, if using a custom Dockerfile:

COPY --chown=superset superset_config.py /app/
ENV SUPERSET_CONFIG_PATH /app/superset_config.py

In your superset_config.py, you can set various parameters such as:

# Superset specific config
ROW_LIMIT = 5000

# Flask App Builder configuration
SECRET_KEY = 'YOUR_OWN_RANDOM_GENERATED_SECRET_KEY'
SQLALCHEMY_DATABASE_URI = 'sqlite:////path/to/superset.db?check_same_thread=false'
WTF_CSRF_ENABLED = True
WTF_CSRF_EXEMPT_LIST = []
WTF_CSRF_TIME_LIMIT = 60 * 60 * 24 * 365
MAPBOX_API_KEY = ''

This approach allows you to configure Superset without altering the core source code ^[2][3].

To continue talking to Dosu, mention @dosu.

[zwickera]

Per the suggestion of @dosu I was hoping to add this to the superset_config.py that is already set up. However, adding the following block of code to superset_config.py is not working, the dropdown still shows the original values, not the updated values with 400 and 800:

PAGE_SIZE_OPTIONS = [
[10, '10'],
[25, '25'],
[50, '50'],
[100, '100'],
[500, '500'],
[1000, '1000']
];

Per review of the intent of superset_config.py, it looks like this is intended to allow overriding values that are already configured in /superset/config.py. PAGE_SIZE_OPTIONS is not a setting in the config.py file, instead it's a setting in code. If there is a way to modify values for PAGE_SIZE_OPTIONS within superset_config.py, I'll need additional assistance for how to access and modify this array. If doing so is not possible, and can only be done via code modification, let me know. Thank you.

[dosubot[bot]]

You are correct. The PAGE_SIZE_OPTIONS array is defined in the frontend code and cannot be directly modified through the superset_config.py file. To change the options in the "Show Entries" dropdown, you need to modify the frontend code.

The PAGE_SIZE_OPTIONS array is defined in the superset-frontend/plugins/plugin-chart-table/src/consts.ts file. You can add the desired values (e.g., 500 and 1000) to this array. Here is how you can do it:

1. Open the superset-frontend/plugins/plugin-chart-table/src/consts.ts file.
2. Modify the PAGE_SIZE_OPTIONS array to include the new values:

export const PAGE_SIZE_OPTIONS = formatSelectOptions<number>([
  [0, t('page_size.all')],
  10,
  20,
  50,
  100,
  200,
  500,  // Add 500
  1000, // Add 1000
]);

After making these changes, you will need to rebuild the frontend and redeploy your Superset instance. Here are the general steps to do that:

1. Install Dependencies:

   cd superset-frontend
   npm install

2. Build the Frontend:

   npm run build

3. Restart Superset:
   Restart your Superset server to apply the changes.

This will update the "Show Entries" dropdown to include the new options ^[1].

To continue talking to Dosu, mention @dosu.