Add series tool in query builder

config/specify_datamodel.xml

@@ -4169,6 +4169,7 @@
       <field column="Remarks" name="remarks" type="text" length="4096" updatable="true" required="false" unique="false" indexed="false" partialDate="false"/>
       <field column="SearchSynonymy" name="searchSynonymy" type="java.lang.Boolean" updatable="true" required="false" unique="false" indexed="false" partialDate="false"/>
       <field column="SelectDistinct" name="selectDistinct" type="java.lang.Boolean" updatable="true" required="false" unique="false" indexed="false" partialDate="false"/>
+      <field column="SelectSeries" name="SelectSeries" type="java.lang.Boolean" updatable="true" required="false" unique="false" indexed="false" partialDate="false"/>
       <field column="Smushed" name="smushed" type="java.lang.Boolean" updatable="true" required="false" unique="false" indexed="false" partialDate="false"/>
       <field column="SqlStr" name="sqlStr" type="text" length="4096" updatable="true" required="false" unique="false" indexed="false" partialDate="false"/>
       <field column="TimestampCreated" name="timestampCreated" type="java.sql.Timestamp" updatable="false" required="true" unique="false" indexed="false" partialDate="false"/>

specifyweb/frontend/js_src/lib/components/DataModel/__tests__/helpers.test.ts

@@ -123,6 +123,7 @@ describe('serializeResource', () => {
       remarks: null,
       searchSynonymy: null,
       selectDistinct: null,
+      selectSeries: null,
       smushed: null,
       specifyUser: null,
       sqlStr: null,

specifyweb/frontend/js_src/lib/components/DataModel/types.ts

@@ -5299,6 +5299,7 @@ export type SpQuery = {
     readonly remarks: string | null;
     readonly searchSynonymy: boolean | null;
     readonly selectDistinct: boolean | null;
+    readonly selectSeries: boolean | null;
     readonly smushed: boolean | null;
     readonly sqlStr: string | null;
     readonly timestampCreated: string;

specifyweb/frontend/js_src/lib/components/Forms/__tests__/DeleteButton.test.tsx

@@ -105,6 +105,7 @@ overrideAjax(
       resource_uri: undefined,
       searchsynonymy: null,
       selectdistinct: false,
+      selectseries: false,
       smushed: null,
       specifyuser: '/api/specify/specifyuser/2/',
       sqlstr: null,

specifyweb/frontend/js_src/lib/components/QueryBuilder/Toolbar.tsx

@@ -13,16 +13,22 @@ export function QueryToolbar({
   showHiddenFields,
   tableName,
   isDistinct,
+  isSeries,
+  showSeries,
   onToggleHidden: handleToggleHidden,
   onToggleDistinct: handleToggleDistinct,
+  onToggleSeries: handleToggleSeries,
   onRunCountOnly: handleRunCountOnly,
   onSubmitClick: handleSubmitClick,
 }: {
   readonly showHiddenFields: boolean;
   readonly tableName: keyof Tables;
   readonly isDistinct: boolean;
+  readonly isSeries: boolean;
+  readonly showSeries: boolean;
   readonly onToggleHidden: (value: boolean) => void;
   readonly onToggleDistinct: () => void;
+  readonly onToggleSeries: () => void;
   readonly onRunCountOnly: () => void;
   readonly onSubmitClick: () => void;
 }): JSX.Element {
@@ -38,6 +44,16 @@ export function QueryToolbar({
       <span className="-ml-2 flex-1" />
       {hasPermission('/querybuilder/query', 'execute') && (
         <>
+          {showSeries && (
+            <Label.Inline>
+              <Input.Checkbox
+                checked={isSeries}
+                isReadOnly={isDistinct}
+                onChange={handleToggleSeries}
+              />
+              {queryText.series()}
+            </Label.Inline>
+          )}
           {/*
            * Query Distinct for trees is disabled because of
            * https://github.com/specify/specify7/pull/1019#issuecomment-973525594
@@ -46,6 +62,7 @@ export function QueryToolbar({
             <Label.Inline>
               <Input.Checkbox
                 checked={isDistinct}
+                isReadOnly={isSeries}
                 onChange={handleToggleDistinct}
               />
               {queryText.distinct()}

specifyweb/frontend/js_src/lib/components/QueryBuilder/Wrapped.tsx

@@ -96,6 +96,7 @@ function Wrapped({
   readonly onChange?: (props: {
     readonly fields: RA<SerializedResource<SpQueryField>>;
     readonly isDistinct: boolean | null;
+    readonly isSeries: boolean | null;
   }) => void;
 }): JSX.Element {
   const [query, setQuery] = useResource(queryResource);
@@ -160,8 +161,9 @@ function Wrapped({
     handleChange?.({
       fields: unParseQueryFields(state.baseTableName, state.fields),
       isDistinct: query.selectDistinct,
+      isSeries: query.selectSeries,
     });
-  }, [state, query.selectDistinct]);
+  }, [state, query.selectDistinct, query.selectSeries]);
 
   /**
    * If tried to save a query, enforce the field length limit for the
@@ -299,6 +301,23 @@ function Wrapped({
     undefined
   );
 
+  const showSeries = React.useMemo(
+    () =>
+      table.name === 'CollectionObject' &&
+      state.fields.some(
+        (field) => field.mappingPath[0] === 'catalogNumber' && field.isDisplay
+      ),
+    [state, table.name]
+  );
+
+  React.useEffect(() => {
+    if (!showSeries)
+      setQuery({
+        ...query,
+        selectSeries: false,
+      });
+  }, [showSeries]);
+
   return treeRanksLoaded ? (
     <ReadOnlyContext.Provider value={isReadOnly}>
       <IsQueryBasicContext.Provider value={isBasic}>
@@ -559,7 +578,9 @@ function Wrapped({
               />
               <QueryToolbar
                 isDistinct={query.selectDistinct ?? false}
+                isSeries={query.selectSeries ?? false}
                 showHiddenFields={showHiddenFields}
+                showSeries={showSeries}
                 tableName={table.name}
                 onRunCountOnly={(): void => runQuery('count')}
                 onSubmitClick={(): void =>
@@ -574,6 +595,12 @@ function Wrapped({
                   })
                 }
                 onToggleHidden={setShowHiddenFields}
+                onToggleSeries={(): void =>
+                  setQuery({
+                    ...query,
+                    selectSeries: !(query.selectSeries ?? false),
+                  })
+                }
               />
             </div>
             {hasPermission('/querybuilder/query', 'execute') && (

specifyweb/frontend/js_src/lib/components/QueryBuilder/__tests__/__snapshots__/fromTree.test.ts.snap

@@ -86,6 +86,7 @@ exports[`queryFromTree 1`] = `
     "name": "Collection Object using \\"Los Angeles County\\"",
     "ordinal": 32767,
     "selectdistinct": false,
+    "selectseries": false,
     "specifyuser": "/api/specify/specifyuser/2/",
   },
   {
@@ -160,6 +161,7 @@ exports[`queryFromTree 1`] = `
     "name": "Collection Object using \\"Cabinet 1\\"",
     "ordinal": 32767,
     "selectdistinct": false,
+    "selectseries": false,
     "specifyuser": "/api/specify/specifyuser/2/",
   },
   {
@@ -234,6 +236,7 @@ exports[`queryFromTree 1`] = `
     "name": "Collection Object using \\"Carpiodes velifer\\"",
     "ordinal": 32767,
     "selectdistinct": false,
+    "selectseries": false,
     "specifyuser": "/api/specify/specifyuser/2/",
   },
   {
@@ -308,6 +311,7 @@ exports[`queryFromTree 1`] = `
     "name": "Collection Object using \\"Paleocene\\"",
     "ordinal": 32767,
     "selectdistinct": false,
+    "selectseries": false,
     "specifyuser": "/api/specify/specifyuser/2/",
   },
   {
@@ -382,6 +386,7 @@ exports[`queryFromTree 1`] = `
     "name": "Collection Object using \\"Cretaceous\\"",
     "ordinal": 32767,
     "selectdistinct": false,
+    "selectseries": false,
     "specifyuser": "/api/specify/specifyuser/2/",
   },
   {
@@ -456,6 +461,7 @@ exports[`queryFromTree 1`] = `
     "name": "Collection Object using \\"Plate\\"",
     "ordinal": 32767,
     "selectdistinct": false,
+    "selectseries": false,
     "specifyuser": "/api/specify/specifyuser/2/",
   },
 ]

specifyweb/frontend/js_src/lib/components/QueryBuilder/index.tsx

@@ -97,6 +97,7 @@ export function createQuery(
   query.set('contextName', table.name);
   query.set('contextTableId', table.tableId);
   query.set('selectDistinct', false);
+  query.set('selectSeries', false);
   query.set('countOnly', false);
   query.set('formatAuditRecIds', false);
   query.set('specifyUser', userInformation.resource_uri);

specifyweb/frontend/js_src/lib/components/QueryComboBox/helpers.ts

@@ -35,6 +35,7 @@ export function makeComboBoxQuery({
   query.set('contextName', table.name);
   query.set('contextTableId', table.tableId);
   query.set('selectDistinct', false);
+  query.set('selectSeries', false);
   query.set('countOnly', false);
   query.set('specifyUser', userInformation.resource_uri);
   query.set('isFavorite', false);

specifyweb/frontend/js_src/lib/localization/query.ts

@@ -303,6 +303,9 @@ export const queryText = createDictionary({
     'uk-ua': 'Виразний',
     'de-ch': 'Unterscheidbar',
   },
+  series: {
+    'en-us': 'Series',
+  },
   createCsv: {
     'en-us': 'Create CSV',
     'ru-ru': 'Создать CSV-файл',

specifyweb/frontend/js_src/lib/tests/ajax/static/context/datamodel.json

@@ -31078,6 +31078,14 @@
         "required": false,
         "type": "java.lang.Boolean"
       },
+      {
+        "name": "selectSeries",
+        "column": "SelectSeries",
+        "indexed": false,
+        "unique": false,
+        "required": false,
+        "type": "java.lang.Boolean"
+      },
       {
         "name": "smushed",
         "column": "Smushed",

specifyweb/frontend/js_src/lib/tests/ajax/static/context/schema_localization.json/lang=en.json

@@ -38532,6 +38532,17 @@
         "name": "Select Distinct",
         "desc": "Select Distinct"
       },
+      "selectseries": {
+        "format": null,
+        "ishidden": false,
+        "isuiformatter": false,
+        "picklistname": null,
+        "type": null,
+        "isrequired": false,
+        "weblinkname": null,
+        "name": "Select Series",
+        "desc": "Select Series"
+      },
       "smushed": {
         "format": null,
         "ishidden": false,

specifyweb/specify/datamodel.py

@@ -6595,6 +6595,7 @@ def is_tree_table(table: Table):
             Field(name='remarks', column='Remarks', indexed=False, unique=False, required=False, type='text', length=4096),
             Field(name='searchSynonymy', column='SearchSynonymy', indexed=False, unique=False, required=False, type='java.lang.Boolean'),
             Field(name='selectDistinct', column='SelectDistinct', indexed=False, unique=False, required=False, type='java.lang.Boolean'),
+            Field(name='selectSeries', column='SelectSeries', indexed=False, unique=False, required=False, type='java.lang.Boolean'),
             Field(name='smushed', column='Smushed', indexed=False, unique=False, required=False, type='java.lang.Boolean'),
             Field(name='sqlStr', column='SqlStr', indexed=False, unique=False, required=False, type='text', length=4096),
             Field(name='timestampCreated', column='TimestampCreated', indexed=False, unique=False, required=True, type='java.sql.Timestamp'),

specifyweb/specify/migrations/0028_selectseries.py

@@ -0,0 +1,18 @@
+# Generated by Django 3.2.15 on 2025-03-25 17:03
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('specify', '0027_CO_children'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='spquery',
+            name='selectseries',
+            field=models.BooleanField(blank=True, db_column='SelectSeries', null=True),
+        ),
+    ]

specifyweb/specify/models.py

@@ -6261,6 +6261,7 @@ class Spquery(models.Model):
     remarks = models.TextField(blank=True, null=True, unique=False, db_column='Remarks', db_index=False)
     searchsynonymy = models.BooleanField(blank=True, null=True, unique=False, db_column='SearchSynonymy', db_index=False)
     selectdistinct = models.BooleanField(blank=True, null=True, unique=False, db_column='SelectDistinct', db_index=False)
+    selectseries = models.BooleanField(blank=True, null=True, unique=False, db_column='SelectSeries', db_index=False)
     smushed = models.BooleanField(blank=True, null=True, unique=False, db_column='Smushed', db_index=False)
     sqlstr = models.TextField(blank=True, null=True, unique=False, db_column='SqlStr', db_index=False)
     timestampcreated = models.DateTimeField(blank=False, null=False, unique=False, db_column='TimestampCreated', db_index=False, default=timezone.now)

specifyweb/specify/temp_models.py

@@ -5011,6 +5011,7 @@ class Spquery(models.Model):
     remarks = models.TextField(db_column='Remarks', blank=True, null=True)  # Field name made lowercase.
     searchsynonymy = models.BooleanField(db_column='SearchSynonymy', blank=True, null=True)  # Field name made lowercase.
     selectdistinct = models.BooleanField(db_column='SelectDistinct', blank=True, null=True)  # Field name made lowercase.
+    selectseries = models.BooleanField(db_column='SelectSeries', blank=True, null=True)
     sqlstr = models.TextField(db_column='SqlStr', blank=True, null=True)  # Field name made lowercase.
     modifiedbyagentid = models.ForeignKey(Agent, models.DO_NOTHING, db_column='ModifiedByAgentID', blank=True, null=True)  # Field name made lowercase.
     specifyuserid = models.ForeignKey(Specifyuser, models.DO_NOTHING, db_column='SpecifyUserID')  # Field name made lowercase.

specifyweb/specify/utils.py

@@ -41,9 +41,9 @@ def log_sqlalchemy_query(query):
     from sqlalchemy.dialects import mysql
     compiled_query = query.statement.compile(dialect=mysql.dialect(), compile_kwargs={"literal_binds": True})
     raw_sql = str(compiled_query).replace('\n', ' ') + ';'
-    logger.debug('============== SQL Query ==============')
+    logger.debug('='.join(['' for _ in range(80)]))
     logger.debug(raw_sql)
-    logger.debug('=======================================')
+    logger.debug('='.join(['' for _ in range(80)]))
     # Run in the storred_queries.execute file, in the execute function, right before the return statement, line 546
     # from specifyweb.specify.utils import log_sqlalchemy_query; log_sqlalchemy_query(query)
 

specifyweb/stored_queries/batch_edit.py

@@ -1109,6 +1109,7 @@ def run_batch_edit_query(props: BatchEditProps):
             user=props["user"],
             tableid=tableid,
             distinct=True,
+            series=False,
             count_only=False,
             field_specs=query_with_hidden,
             limit=limit,